Rethink the delay-checkpoint-end mechanism in the back-branches.
authorRobert Haas <[email protected]>
Thu, 14 Apr 2022 15:10:18 +0000 (11:10 -0400)
committerRobert Haas <[email protected]>
Thu, 14 Apr 2022 15:10:18 +0000 (11:10 -0400)
The back-patch of commit bbace5697df12398e87ffd9879171c39d27f5b33 had
the unfortunate effect of changing the layout of PGPROC in the
back-branches, which could break extensions. This happened because it
changed the delayChkpt from type bool to type int. So, change it back,
and add a new bool delayChkptEnd field instead. The new field should
fall within what used to be padding space within the struct, and so
hopefully won't cause any extensions to break.

Per report from Markus Wanner and discussion with Tom Lane and others.

Patch originally by me, somewhat revised by Markus Wanner per a
suggestion from Michael Paquier. A very similar patch was developed
by Kyotaro Horiguchi, but I failed to see the email in which that was
posted before writing one of my own.

Discussion: http://postgr.es/m/CA+Tgmoao-kUD9c5nG5sub3F7tbo39+cdr8jKaOVEs_1aBWcJ3Q@mail.gmail.com
Discussion: http://postgr.es/m/20220406.164521.17171257901083417[email protected]

src/backend/access/transam/multixact.c
src/backend/access/transam/twophase.c
src/backend/access/transam/xact.c
src/backend/access/transam/xlog.c
src/backend/access/transam/xloginsert.c
src/backend/catalog/storage.c
src/backend/storage/buffer/bufmgr.c
src/backend/storage/ipc/procarray.c
src/include/storage/proc.h
src/include/storage/procarray.h

index 1e52972bbf604ca4949e1678df050e7317f01d9e..cdaf49934802fdbbd848672693e43afa14f96a7c 100644 (file)
@@ -3069,8 +3069,8 @@ TruncateMultiXact(MultiXactId newOldestMulti, Oid newOldestMultiDB)
     * crash/basebackup, even though the state of the data directory would
     * require it.
     */
-   Assert((MyPgXact->delayChkpt & DELAY_CHKPT_START) == 0);
-   MyPgXact->delayChkpt |= DELAY_CHKPT_START;
+   Assert(!MyPgXact->delayChkpt);
+   MyPgXact->delayChkpt = true;
 
    /* WAL log truncation */
    WriteMTruncateXlogRec(newOldestMultiDB,
@@ -3096,7 +3096,7 @@ TruncateMultiXact(MultiXactId newOldestMulti, Oid newOldestMultiDB)
    /* Then offsets */
    PerformOffsetsTruncation(oldestMulti, newOldestMulti);
 
-   MyPgXact->delayChkpt &= ~DELAY_CHKPT_START;
+   MyPgXact->delayChkpt = false;
 
    END_CRIT_SECTION();
    LWLockRelease(MultiXactTruncationLock);
index c61b2736a1fa2bea0eec0960b760cac51628e157..b09ed0b5817cf3fa551234982cae16b6fb62a45b 100644 (file)
@@ -478,8 +478,9 @@ MarkAsPreparingGuts(GlobalTransaction gxact, TransactionId xid, const char *gid,
    }
    pgxact->xid = xid;
    pgxact->xmin = InvalidTransactionId;
-   pgxact->delayChkpt = 0;
+   pgxact->delayChkpt = false;
    pgxact->vacuumFlags = 0;
+   proc->delayChkptEnd = false;
    proc->pid = 0;
    proc->databaseId = databaseid;
    proc->roleId = owner;
@@ -1159,8 +1160,8 @@ EndPrepare(GlobalTransaction gxact)
 
    START_CRIT_SECTION();
 
-   Assert((MyPgXact->delayChkpt & DELAY_CHKPT_START) == 0);
-   MyPgXact->delayChkpt |= DELAY_CHKPT_START;
+   Assert(!MyPgXact->delayChkpt);
+   MyPgXact->delayChkpt = true;
 
    XLogBeginInsert();
    for (record = records.head; record != NULL; record = record->next)
@@ -1192,7 +1193,7 @@ EndPrepare(GlobalTransaction gxact)
     * checkpoint starting after this will certainly see the gxact as a
     * candidate for fsyncing.
     */
-   MyPgXact->delayChkpt &= ~DELAY_CHKPT_START;
+   MyPgXact->delayChkpt = false;
 
    /*
     * Remember that we have this GlobalTransaction entry locked for us.  If
@@ -2285,8 +2286,8 @@ RecordTransactionCommitPrepared(TransactionId xid,
    START_CRIT_SECTION();
 
    /* See notes in RecordTransactionCommit */
-   Assert((MyPgXact->delayChkpt & DELAY_CHKPT_START) == 0);
-   MyPgXact->delayChkpt |= DELAY_CHKPT_START;
+   Assert(!MyPgXact->delayChkpt);
+   MyPgXact->delayChkpt = true;
 
    /*
     * Emit the XLOG commit record. Note that we mark 2PC commits as
@@ -2334,7 +2335,7 @@ RecordTransactionCommitPrepared(TransactionId xid,
    TransactionIdCommitTree(xid, nchildren, children);
 
    /* Checkpoint can proceed now */
-   MyPgXact->delayChkpt &= ~DELAY_CHKPT_START;
+   MyPgXact->delayChkpt = false;
 
    END_CRIT_SECTION();
 
index ccd99c38c27f41a11fb441591a6b203b2406a63f..6c64eecf977a3cf1d9092fd9d745a26f7babc8db 100644 (file)
@@ -1247,9 +1247,9 @@ RecordTransactionCommit(void)
         * This makes checkpoint's determination of which xacts are delayChkpt
         * a bit fuzzy, but it doesn't matter.
         */
-       Assert((MyPgXact->delayChkpt & DELAY_CHKPT_START) == 0);
+       Assert(!MyPgXact->delayChkpt);
        START_CRIT_SECTION();
-       MyPgXact->delayChkpt |= DELAY_CHKPT_START;
+       MyPgXact->delayChkpt = true;
 
        SetCurrentTransactionStopTimestamp();
 
@@ -1350,7 +1350,7 @@ RecordTransactionCommit(void)
     */
    if (markXidCommitted)
    {
-       MyPgXact->delayChkpt &= ~DELAY_CHKPT_START;
+       MyPgXact->delayChkpt = false;
        END_CRIT_SECTION();
    }
 
index 51efc106a2c9e87809888a97ae4b5b7047b6be7a..be6d9b239a5fddf194cb17c9d36269e10e32a9db 100644 (file)
@@ -9022,27 +9022,25 @@ CreateCheckPoint(int flags)
     * and we will correctly flush the update below.  So we cannot miss any
     * xacts we need to wait for.
     */
-   vxids = GetVirtualXIDsDelayingChkpt(&nvxids, DELAY_CHKPT_START);
+   vxids = GetVirtualXIDsDelayingChkpt(&nvxids);
    if (nvxids > 0)
    {
        do
        {
            pg_usleep(10000L);  /* wait for 10 msec */
-       } while (HaveVirtualXIDsDelayingChkpt(vxids, nvxids,
-                                             DELAY_CHKPT_START));
+       } while (HaveVirtualXIDsDelayingChkpt(vxids, nvxids));
    }
    pfree(vxids);
 
    CheckPointGuts(checkPoint.redo, flags);
 
-   vxids = GetVirtualXIDsDelayingChkpt(&nvxids, DELAY_CHKPT_COMPLETE);
+   vxids = GetVirtualXIDsDelayingChkptEnd(&nvxids);
    if (nvxids > 0)
    {
        do
        {
            pg_usleep(10000L);  /* wait for 10 msec */
-       } while (HaveVirtualXIDsDelayingChkpt(vxids, nvxids,
-                                             DELAY_CHKPT_COMPLETE));
+       } while (HaveVirtualXIDsDelayingChkptEnd(vxids, nvxids));
    }
    pfree(vxids);
 
index 6ff19814d49f5151632ce5528562eaafb1e3157c..579d8de775959157a99c75097b18d0a2925953c1 100644 (file)
@@ -899,7 +899,7 @@ XLogSaveBufferForHint(Buffer buffer, bool buffer_std)
    /*
     * Ensure no checkpoint can change our view of RedoRecPtr.
     */
-   Assert((MyPgXact->delayChkpt & DELAY_CHKPT_START) != 0);
+   Assert(MyPgXact->delayChkpt);
 
    /*
     * Update RedoRecPtr so that we can make the right decision
index 729fb92c5fe9e837c5790d5e95ce6dec07882103..9497e1d88d50b8ab8058ed4b3595e74005cab08b 100644 (file)
@@ -263,8 +263,8 @@ RelationTruncate(Relation rel, BlockNumber nblocks)
     * the blocks to not exist on disk at all, but not for them to have the
     * wrong contents.
     */
-   Assert((MyPgXact->delayChkpt & DELAY_CHKPT_COMPLETE) == 0);
-   MyPgXact->delayChkpt |= DELAY_CHKPT_COMPLETE;
+   Assert(!MyProc->delayChkptEnd);
+   MyProc->delayChkptEnd = true;
 
    /*
     * We WAL-log the truncation before actually truncating, which means
@@ -312,7 +312,7 @@ RelationTruncate(Relation rel, BlockNumber nblocks)
    smgrtruncate(rel->rd_smgr, MAIN_FORKNUM, nblocks);
 
    /* We've done all the critical work, so checkpoints are OK now. */
-   MyPgXact->delayChkpt &= ~DELAY_CHKPT_COMPLETE;
+   MyProc->delayChkptEnd = false;
 }
 
 /*
index 0b7bdb8634f561f2a018ce1f5ab0c3f36dde8e9b..164abf2efeaad71d1f80917bf0c725be5367b7a6 100644 (file)
@@ -3469,8 +3469,8 @@ MarkBufferDirtyHint(Buffer buffer, bool buffer_std)
             * essential that CreateCheckpoint waits for virtual transactions
             * rather than full transactionids.
             */
-           Assert((MyPgXact->delayChkpt & DELAY_CHKPT_START) == 0);
-           MyPgXact->delayChkpt |= DELAY_CHKPT_START;
+           Assert(!MyPgXact->delayChkpt);
+           MyPgXact->delayChkpt = true;
            delayChkpt = true;
            lsn = XLogSaveBufferForHint(buffer, buffer_std);
        }
@@ -3504,7 +3504,7 @@ MarkBufferDirtyHint(Buffer buffer, bool buffer_std)
        UnlockBufHdr(bufHdr, buf_state);
 
        if (delayChkpt)
-           MyPgXact->delayChkpt &= ~DELAY_CHKPT_START;
+           MyPgXact->delayChkpt = false;
 
        if (dirtied)
        {
index 134b63f28b8dbf6ad52e5b29a1efdb68d96cf863..6cf1157c27c814f7178b53f311c34d2129e03713 100644 (file)
@@ -151,6 +151,11 @@ static void DisplayXidCache(void);
 #define xc_slow_answer_inc()       ((void) 0)
 #endif                         /* XIDCACHE_DEBUG */
 
+static VirtualTransactionId *GetVirtualXIDsDelayingChkptGuts(int *nvxids,
+                                                            int type);
+static bool HaveVirtualXIDsDelayingChkptGuts(VirtualTransactionId *vxids,
+                                            int nvxids, int type);
+
 /* Primitives for KnownAssignedXids array handling for standby */
 static void KnownAssignedXidsCompress(bool force);
 static void KnownAssignedXidsAdd(TransactionId from_xid, TransactionId to_xid,
@@ -434,8 +439,9 @@ ProcArrayEndTransaction(PGPROC *proc, TransactionId latestXid)
        /* must be cleared with xid/xmin: */
        pgxact->vacuumFlags &= ~PROC_VACUUM_STATE_MASK;
 
-       /* be sure this is cleared in abort */
-       pgxact->delayChkpt = 0;
+       /* be sure these are cleared in abort */
+       pgxact->delayChkpt = false;
+       proc->delayChkptEnd = false;
 
        proc->recoveryConflictPending = false;
 
@@ -459,8 +465,9 @@ ProcArrayEndTransactionInternal(PGPROC *proc, PGXACT *pgxact,
    /* must be cleared with xid/xmin: */
    pgxact->vacuumFlags &= ~PROC_VACUUM_STATE_MASK;
 
-   /* be sure this is cleared in abort */
-   pgxact->delayChkpt = 0;
+   /* be sure these are cleared in abort */
+   pgxact->delayChkpt = false;
+   proc->delayChkptEnd = false;
 
    proc->recoveryConflictPending = false;
 
@@ -2261,26 +2268,28 @@ GetOldestSafeDecodingTransactionId(bool catalogOnly)
 }
 
 /*
- * GetVirtualXIDsDelayingChkpt -- Get the VXIDs of transactions that are
- * delaying checkpoint because they have critical actions in progress.
+ * GetVirtualXIDsDelayingChkptGuts -- Get the VXIDs of transactions that are
+ * delaying the start or end of a checkpoint because they have critical
+ * actions in progress.
  *
  * Constructs an array of VXIDs of transactions that are currently in commit
- * critical sections, as shown by having specified delayChkpt bits set in their
- * PGXACT.
+ * critical sections, as shown by having specified delayChkpt or delayChkptEnd
+ * set.
  *
  * Returns a palloc'd array that should be freed by the caller.
  * *nvxids is the number of valid entries.
  *
- * Note that because backends set or clear delayChkpt without holding any lock,
- * the result is somewhat indeterminate, but we don't really care.  Even in
- * a multiprocessor with delayed writes to shared memory, it should be certain
- * that setting of delayChkpt will propagate to shared memory when the backend
- * takes a lock, so we cannot fail to see a virtual xact as delayChkpt if
- * it's already inserted its commit record.  Whether it takes a little while
- * for clearing of delayChkpt to propagate is unimportant for correctness.
+ * Note that because backends set or clear delayChkpt and delayChkptEnd
+ * without holding any lock, the result is somewhat indeterminate, but we
+ * don't really care.  Even in a multiprocessor with delayed writes to
+ * shared memory, it should be certain that setting of delayChkpt will
+ * propagate to shared memory when the backend takes a lock, so we cannot
+ * fail to see a virtual xact as delayChkpt if it's already inserted its
+ * commit record.  Whether it takes a little while for clearing of
+ * delayChkpt to propagate is unimportant for correctness.
  */
-VirtualTransactionId *
-GetVirtualXIDsDelayingChkpt(int *nvxids, int type)
+static VirtualTransactionId *
+GetVirtualXIDsDelayingChkptGuts(int *nvxids, int type)
 {
    VirtualTransactionId *vxids;
    ProcArrayStruct *arrayP = procArray;
@@ -2301,7 +2310,8 @@ GetVirtualXIDsDelayingChkpt(int *nvxids, int type)
        volatile PGPROC *proc = &allProcs[pgprocno];
        volatile PGXACT *pgxact = &allPgXact[pgprocno];
 
-       if ((pgxact->delayChkpt & type) != 0)
+       if (((type & DELAY_CHKPT_START) && pgxact->delayChkpt) ||
+           ((type & DELAY_CHKPT_COMPLETE) && proc->delayChkptEnd))
        {
            VirtualTransactionId vxid;
 
@@ -2317,6 +2327,26 @@ GetVirtualXIDsDelayingChkpt(int *nvxids, int type)
    return vxids;
 }
 
+/*
+ * GetVirtualXIDsDelayingChkpt - Get the VXIDs of transactions that are
+ * delaying the start of a checkpoint.
+ */
+VirtualTransactionId *
+GetVirtualXIDsDelayingChkpt(int *nvxids)
+{
+   return GetVirtualXIDsDelayingChkptGuts(nvxids, DELAY_CHKPT_START);
+}
+
+/*
+ * GetVirtualXIDsDelayingChkptEnd - Get the VXIDs of transactions that are
+ * delaying the end of a checkpoint.
+ */
+VirtualTransactionId *
+GetVirtualXIDsDelayingChkptEnd(int *nvxids)
+{
+   return GetVirtualXIDsDelayingChkptGuts(nvxids, DELAY_CHKPT_COMPLETE);
+}
+
 /*
  * HaveVirtualXIDsDelayingChkpt -- Are any of the specified VXIDs delaying?
  *
@@ -2326,8 +2356,9 @@ GetVirtualXIDsDelayingChkpt(int *nvxids, int type)
  * Note: this is O(N^2) in the number of vxacts that are/were delaying, but
  * those numbers should be small enough for it not to be a problem.
  */
-bool
-HaveVirtualXIDsDelayingChkpt(VirtualTransactionId *vxids, int nvxids, int type)
+static bool
+HaveVirtualXIDsDelayingChkptGuts(VirtualTransactionId *vxids, int nvxids,
+                                int type)
 {
    bool        result = false;
    ProcArrayStruct *arrayP = procArray;
@@ -2346,7 +2377,8 @@ HaveVirtualXIDsDelayingChkpt(VirtualTransactionId *vxids, int nvxids, int type)
 
        GET_VXID_FROM_PGPROC(vxid, *proc);
 
-       if ((pgxact->delayChkpt & type) != 0 &&
+       if ((((type & DELAY_CHKPT_START) && pgxact->delayChkpt) ||
+            ((type & DELAY_CHKPT_COMPLETE) && proc->delayChkptEnd)) &&
            VirtualTransactionIdIsValid(vxid))
        {
            int         i;
@@ -2369,6 +2401,28 @@ HaveVirtualXIDsDelayingChkpt(VirtualTransactionId *vxids, int nvxids, int type)
    return result;
 }
 
+/*
+ * HaveVirtualXIDsDelayingChkpt -- Are any of the specified VXIDs delaying
+ * the start of a checkpoint?
+ */
+bool
+HaveVirtualXIDsDelayingChkpt(VirtualTransactionId *vxids, int nvxids)
+{
+   return HaveVirtualXIDsDelayingChkptGuts(vxids, nvxids,
+                                           DELAY_CHKPT_START);
+}
+
+/*
+ * HaveVirtualXIDsDelayingChkptEnd -- Are any of the specified VXIDs delaying
+ * the end of a checkpoint?
+ */
+bool
+HaveVirtualXIDsDelayingChkptEnd(VirtualTransactionId *vxids, int nvxids)
+{
+   return HaveVirtualXIDsDelayingChkptGuts(vxids, nvxids,
+                                           DELAY_CHKPT_COMPLETE);
+}
+
 /*
  * BackendPidGetProc -- get a backend's PGPROC given its PID
  *
index d8dd7bf5e1c55d56bb6b196f191d8bd851e8d5d7..f58058f331e474607eb8df932d4d2f9f4644821e 100644 (file)
@@ -76,36 +76,8 @@ struct XidCache
 #define INVALID_PGPROCNO       PG_INT32_MAX
 
 /*
- * Flags for PGPROC.delayChkpt
- *
- * These flags can be used to delay the start or completion of a checkpoint
- * for short periods. A flag is in effect if the corresponding bit is set in
- * the PGPROC of any backend.
- *
- * For our purposes here, a checkpoint has three phases: (1) determine the
- * location to which the redo pointer will be moved, (2) write all the
- * data durably to disk, and (3) WAL-log the checkpoint.
- *
- * Setting DELAY_CHKPT_START prevents the system from moving from phase 1
- * to phase 2. This is useful when we are performing a WAL-logged modification
- * of data that will be flushed to disk in phase 2. By setting this flag
- * before writing WAL and clearing it after we've both written WAL and
- * performed the corresponding modification, we ensure that if the WAL record
- * is inserted prior to the new redo point, the corresponding data changes will
- * also be flushed to disk before the checkpoint can complete. (In the
- * extremely common case where the data being modified is in shared buffers
- * and we acquire an exclusive content lock on the relevant buffers before
- * writing WAL, this mechanism is not needed, because phase 2 will block
- * until we release the content lock and then flush the modified data to
- * disk.)
- *
- * Setting DELAY_CHKPT_COMPLETE prevents the system from moving from phase 2
- * to phase 3. This is useful if we are performing a WAL-logged operation that
- * might invalidate buffers, such as relation truncation. In this case, we need
- * to ensure that any buffers which were invalidated and thus not flushed by
- * the checkpoint are actaully destroyed on disk. Replay can cope with a file
- * or block that doesn't exist, but not with a block that has the wrong
- * contents.
+ * Flags used only for type of internal functions
+ * GetVirtualXIDsDelayingChkptGuts and HaveVirtualXIDsDelayingChkptGuts.
  */
 #define DELAY_CHKPT_START      (1<<0)
 #define DELAY_CHKPT_COMPLETE   (1<<1)
@@ -181,6 +153,12 @@ struct PGPROC
     */
    XLogRecPtr  waitLSN;        /* waiting for this LSN or higher */
    int         syncRepState;   /* wait state for sync rep */
+   bool        delayChkptEnd;  /* true if this proc delays checkpoint end;
+                                * this doesn't have anything to do with
+                                * sync rep but we don't want to change
+                                * the size of PGPROC in released branches
+                                * and thus must fit this new field into
+                                * existing padding space  */
    SHM_QUEUE   syncRepLinks;   /* list link if process is in syncrep queue */
 
    /*
@@ -252,7 +230,7 @@ typedef struct PGXACT
 
    uint8       vacuumFlags;    /* vacuum-related flags, see above */
    bool        overflowed;
-   int         delayChkpt;     /* for DELAY_CHKPT_* flags */
+   bool        delayChkpt;     /* true if this proc delays checkpoint start */
 
    uint8       nxids;
 } PGXACT;
index 2b60b276049abb73756f1c4af493dd63c50a87a0..f6ab996482e5812f6b543f6627215969f92524f0 100644 (file)
@@ -92,9 +92,12 @@ extern TransactionId GetOldestXmin(Relation rel, int flags);
 extern TransactionId GetOldestActiveTransactionId(void);
 extern TransactionId GetOldestSafeDecodingTransactionId(bool catalogOnly);
 
-extern VirtualTransactionId *GetVirtualXIDsDelayingChkpt(int *nvxids, int type);
+extern VirtualTransactionId *GetVirtualXIDsDelayingChkpt(int *nvxids);
+extern VirtualTransactionId *GetVirtualXIDsDelayingChkptEnd(int *nvxids);
 extern bool HaveVirtualXIDsDelayingChkpt(VirtualTransactionId *vxids,
-                                        int nvxids, int type);
+                                        int nvxids);
+extern bool HaveVirtualXIDsDelayingChkptEnd(VirtualTransactionId *vxids,
+                                           int nvxids);
 
 extern PGPROC *BackendPidGetProc(int pid);
 extern PGPROC *BackendPidGetProcWithLock(int pid);