LCOV - code coverage report
Current view: top level - src/backend/postmaster - checkpointer.c (source / functions) Hit Total Coverage
Test: PostgreSQL 16beta1 Lines: 283 338 83.7 %
Date: 2023-05-31 02:11:47 Functions: 15 15 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /*-------------------------------------------------------------------------
       2             :  *
       3             :  * checkpointer.c
       4             :  *
       5             :  * The checkpointer is new as of Postgres 9.2.  It handles all checkpoints.
       6             :  * Checkpoints are automatically dispatched after a certain amount of time has
       7             :  * elapsed since the last one, and it can be signaled to perform requested
       8             :  * checkpoints as well.  (The GUC parameter that mandates a checkpoint every
       9             :  * so many WAL segments is implemented by having backends signal when they
      10             :  * fill WAL segments; the checkpointer itself doesn't watch for the
      11             :  * condition.)
      12             :  *
      13             :  * Normal termination is by SIGUSR2, which instructs the checkpointer to
      14             :  * execute a shutdown checkpoint and then exit(0).  (All backends must be
      15             :  * stopped before SIGUSR2 is issued!)  Emergency termination is by SIGQUIT;
      16             :  * like any backend, the checkpointer will simply abort and exit on SIGQUIT.
      17             :  *
      18             :  * If the checkpointer exits unexpectedly, the postmaster treats that the same
      19             :  * as a backend crash: shared memory may be corrupted, so remaining backends
      20             :  * should be killed by SIGQUIT and then a recovery cycle started.  (Even if
      21             :  * shared memory isn't corrupted, we have lost information about which
      22             :  * files need to be fsync'd for the next checkpoint, and so a system
      23             :  * restart needs to be forced.)
      24             :  *
      25             :  *
      26             :  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
      27             :  *
      28             :  *
      29             :  * IDENTIFICATION
      30             :  *    src/backend/postmaster/checkpointer.c
      31             :  *
      32             :  *-------------------------------------------------------------------------
      33             :  */
      34             : #include "postgres.h"
      35             : 
      36             : #include <sys/time.h>
      37             : #include <time.h>
      38             : 
      39             : #include "access/xlog.h"
      40             : #include "access/xlog_internal.h"
      41             : #include "access/xlogrecovery.h"
      42             : #include "libpq/pqsignal.h"
      43             : #include "miscadmin.h"
      44             : #include "pgstat.h"
      45             : #include "postmaster/bgwriter.h"
      46             : #include "postmaster/interrupt.h"
      47             : #include "replication/syncrep.h"
      48             : #include "storage/bufmgr.h"
      49             : #include "storage/condition_variable.h"
      50             : #include "storage/fd.h"
      51             : #include "storage/ipc.h"
      52             : #include "storage/lwlock.h"
      53             : #include "storage/proc.h"
      54             : #include "storage/procsignal.h"
      55             : #include "storage/shmem.h"
      56             : #include "storage/smgr.h"
      57             : #include "storage/spin.h"
      58             : #include "utils/guc.h"
      59             : #include "utils/memutils.h"
      60             : #include "utils/resowner.h"
      61             : 
      62             : 
      63             : /*----------
      64             :  * Shared memory area for communication between checkpointer and backends
      65             :  *
      66             :  * The ckpt counters allow backends to watch for completion of a checkpoint
      67             :  * request they send.  Here's how it works:
      68             :  *  * At start of a checkpoint, checkpointer reads (and clears) the request
      69             :  *    flags and increments ckpt_started, while holding ckpt_lck.
      70             :  *  * On completion of a checkpoint, checkpointer sets ckpt_done to
      71             :  *    equal ckpt_started.
      72             :  *  * On failure of a checkpoint, checkpointer increments ckpt_failed
      73             :  *    and sets ckpt_done to equal ckpt_started.
      74             :  *
      75             :  * The algorithm for backends is:
      76             :  *  1. Record current values of ckpt_failed and ckpt_started, and
      77             :  *     set request flags, while holding ckpt_lck.
      78             :  *  2. Send signal to request checkpoint.
      79             :  *  3. Sleep until ckpt_started changes.  Now you know a checkpoint has
      80             :  *     begun since you started this algorithm (although *not* that it was
      81             :  *     specifically initiated by your signal), and that it is using your flags.
      82             :  *  4. Record new value of ckpt_started.
      83             :  *  5. Sleep until ckpt_done >= saved value of ckpt_started.  (Use modulo
      84             :  *     arithmetic here in case counters wrap around.)  Now you know a
      85             :  *     checkpoint has started and completed, but not whether it was
      86             :  *     successful.
      87             :  *  6. If ckpt_failed is different from the originally saved value,
      88             :  *     assume request failed; otherwise it was definitely successful.
      89             :  *
      90             :  * ckpt_flags holds the OR of the checkpoint request flags sent by all
      91             :  * requesting backends since the last checkpoint start.  The flags are
      92             :  * chosen so that OR'ing is the correct way to combine multiple requests.
      93             :  *
      94             :  * num_backend_writes is used to count the number of buffer writes performed
      95             :  * by user backend processes.  This counter should be wide enough that it
      96             :  * can't overflow during a single processing cycle.  num_backend_fsync
      97             :  * counts the subset of those writes that also had to do their own fsync,
      98             :  * because the checkpointer failed to absorb their request.
      99             :  *
     100             :  * The requests array holds fsync requests sent by backends and not yet
     101             :  * absorbed by the checkpointer.
     102             :  *
     103             :  * Unlike the checkpoint fields, num_backend_writes, num_backend_fsync, and
     104             :  * the requests fields are protected by CheckpointerCommLock.
     105             :  *----------
     106             :  */
     107             : typedef struct
     108             : {
     109             :     SyncRequestType type;       /* request type */
     110             :     FileTag     ftag;           /* file identifier */
     111             : } CheckpointerRequest;
     112             : 
     113             : typedef struct
     114             : {
     115             :     pid_t       checkpointer_pid;   /* PID (0 if not started) */
     116             : 
     117             :     slock_t     ckpt_lck;       /* protects all the ckpt_* fields */
     118             : 
     119             :     int         ckpt_started;   /* advances when checkpoint starts */
     120             :     int         ckpt_done;      /* advances when checkpoint done */
     121             :     int         ckpt_failed;    /* advances when checkpoint fails */
     122             : 
     123             :     int         ckpt_flags;     /* checkpoint flags, as defined in xlog.h */
     124             : 
     125             :     ConditionVariable start_cv; /* signaled when ckpt_started advances */
     126             :     ConditionVariable done_cv;  /* signaled when ckpt_done advances */
     127             : 
     128             :     uint32      num_backend_writes; /* counts user backend buffer writes */
     129             :     uint32      num_backend_fsync;  /* counts user backend fsync calls */
     130             : 
     131             :     int         num_requests;   /* current # of requests */
     132             :     int         max_requests;   /* allocated array size */
     133             :     CheckpointerRequest requests[FLEXIBLE_ARRAY_MEMBER];
     134             : } CheckpointerShmemStruct;
     135             : 
     136             : static CheckpointerShmemStruct *CheckpointerShmem;
     137             : 
     138             : /* interval for calling AbsorbSyncRequests in CheckpointWriteDelay */
     139             : #define WRITES_PER_ABSORB       1000
     140             : 
     141             : /*
     142             :  * GUC parameters
     143             :  */
     144             : int         CheckPointTimeout = 300;
     145             : int         CheckPointWarning = 30;
     146             : double      CheckPointCompletionTarget = 0.9;
     147             : 
     148             : /*
     149             :  * Private state
     150             :  */
     151             : static bool ckpt_active = false;
     152             : 
     153             : /* these values are valid when ckpt_active is true: */
     154             : static pg_time_t ckpt_start_time;
     155             : static XLogRecPtr ckpt_start_recptr;
     156             : static double ckpt_cached_elapsed;
     157             : 
     158             : static pg_time_t last_checkpoint_time;
     159             : static pg_time_t last_xlog_switch_time;
     160             : 
     161             : /* Prototypes for private functions */
     162             : 
     163             : static void HandleCheckpointerInterrupts(void);
     164             : static void CheckArchiveTimeout(void);
     165             : static bool IsCheckpointOnSchedule(double progress);
     166             : static bool ImmediateCheckpointRequested(void);
     167             : static bool CompactCheckpointerRequestQueue(void);
     168             : static void UpdateSharedMemoryConfig(void);
     169             : 
     170             : /* Signal handlers */
     171             : static void ReqCheckpointHandler(SIGNAL_ARGS);
     172             : 
     173             : 
     174             : /*
     175             :  * Main entry point for checkpointer process
     176             :  *
     177             :  * This is invoked from AuxiliaryProcessMain, which has already created the
     178             :  * basic execution environment, but not enabled signals yet.
     179             :  */
     180             : void
     181         694 : CheckpointerMain(void)
     182             : {
     183             :     sigjmp_buf  local_sigjmp_buf;
     184             :     MemoryContext checkpointer_context;
     185             : 
     186         694 :     CheckpointerShmem->checkpointer_pid = MyProcPid;
     187             : 
     188             :     /*
     189             :      * Properly accept or ignore signals the postmaster might send us
     190             :      *
     191             :      * Note: we deliberately ignore SIGTERM, because during a standard Unix
     192             :      * system shutdown cycle, init will SIGTERM all processes at once.  We
     193             :      * want to wait for the backends to exit, whereupon the postmaster will
     194             :      * tell us it's okay to shut down (via SIGUSR2).
     195             :      */
     196         694 :     pqsignal(SIGHUP, SignalHandlerForConfigReload);
     197         694 :     pqsignal(SIGINT, ReqCheckpointHandler); /* request checkpoint */
     198         694 :     pqsignal(SIGTERM, SIG_IGN); /* ignore SIGTERM */
     199             :     /* SIGQUIT handler was already set up by InitPostmasterChild */
     200         694 :     pqsignal(SIGALRM, SIG_IGN);
     201         694 :     pqsignal(SIGPIPE, SIG_IGN);
     202         694 :     pqsignal(SIGUSR1, procsignal_sigusr1_handler);
     203         694 :     pqsignal(SIGUSR2, SignalHandlerForShutdownRequest);
     204             : 
     205             :     /*
     206             :      * Reset some signals that are accepted by postmaster but not here
     207             :      */
     208         694 :     pqsignal(SIGCHLD, SIG_DFL);
     209             : 
     210             :     /*
     211             :      * Initialize so that first time-driven event happens at the correct time.
     212             :      */
     213         694 :     last_checkpoint_time = last_xlog_switch_time = (pg_time_t) time(NULL);
     214             : 
     215             :     /*
     216             :      * Write out stats after shutdown. This needs to be called by exactly one
     217             :      * process during a normal shutdown, and since checkpointer is shut down
     218             :      * very late...
     219             :      *
     220             :      * Walsenders are shut down after the checkpointer, but currently don't
     221             :      * report stats. If that changes, we need a more complicated solution.
     222             :      */
     223         694 :     before_shmem_exit(pgstat_before_server_shutdown, 0);
     224             : 
     225             :     /*
     226             :      * Create a memory context that we will do all our work in.  We do this so
     227             :      * that we can reset the context during error recovery and thereby avoid
     228             :      * possible memory leaks.  Formerly this code just ran in
     229             :      * TopMemoryContext, but resetting that would be a really bad idea.
     230             :      */
     231         694 :     checkpointer_context = AllocSetContextCreate(TopMemoryContext,
     232             :                                                  "Checkpointer",
     233             :                                                  ALLOCSET_DEFAULT_SIZES);
     234         694 :     MemoryContextSwitchTo(checkpointer_context);
     235             : 
     236             :     /*
     237             :      * If an exception is encountered, processing resumes here.
     238             :      *
     239             :      * You might wonder why this isn't coded as an infinite loop around a
     240             :      * PG_TRY construct.  The reason is that this is the bottom of the
     241             :      * exception stack, and so with PG_TRY there would be no exception handler
     242             :      * in force at all during the CATCH part.  By leaving the outermost setjmp
     243             :      * always active, we have at least some chance of recovering from an error
     244             :      * during error recovery.  (If we get into an infinite loop thereby, it
     245             :      * will soon be stopped by overflow of elog.c's internal state stack.)
     246             :      *
     247             :      * Note that we use sigsetjmp(..., 1), so that the prevailing signal mask
     248             :      * (to wit, BlockSig) will be restored when longjmp'ing to here.  Thus,
     249             :      * signals other than SIGQUIT will be blocked until we complete error
     250             :      * recovery.  It might seem that this policy makes the HOLD_INTERRUPTS()
     251             :      * call redundant, but it is not since InterruptPending might be set
     252             :      * already.
     253             :      */
     254         694 :     if (sigsetjmp(local_sigjmp_buf, 1) != 0)
     255             :     {
     256             :         /* Since not using PG_TRY, must reset error stack by hand */
     257           0 :         error_context_stack = NULL;
     258             : 
     259             :         /* Prevent interrupts while cleaning up */
     260           0 :         HOLD_INTERRUPTS();
     261             : 
     262             :         /* Report the error to the server log */
     263           0 :         EmitErrorReport();
     264             : 
     265             :         /*
     266             :          * These operations are really just a minimal subset of
     267             :          * AbortTransaction().  We don't have very many resources to worry
     268             :          * about in checkpointer, but we do have LWLocks, buffers, and temp
     269             :          * files.
     270             :          */
     271           0 :         LWLockReleaseAll();
     272           0 :         ConditionVariableCancelSleep();
     273           0 :         pgstat_report_wait_end();
     274           0 :         UnlockBuffers();
     275           0 :         ReleaseAuxProcessResources(false);
     276           0 :         AtEOXact_Buffers(false);
     277           0 :         AtEOXact_SMgr();
     278           0 :         AtEOXact_Files(false);
     279           0 :         AtEOXact_HashTables(false);
     280             : 
     281             :         /* Warn any waiting backends that the checkpoint failed. */
     282           0 :         if (ckpt_active)
     283             :         {
     284           0 :             SpinLockAcquire(&CheckpointerShmem->ckpt_lck);
     285           0 :             CheckpointerShmem->ckpt_failed++;
     286           0 :             CheckpointerShmem->ckpt_done = CheckpointerShmem->ckpt_started;
     287           0 :             SpinLockRelease(&CheckpointerShmem->ckpt_lck);
     288             : 
     289           0 :             ConditionVariableBroadcast(&CheckpointerShmem->done_cv);
     290             : 
     291           0 :             ckpt_active = false;
     292             :         }
     293             : 
     294             :         /*
     295             :          * Now return to normal top-level context and clear ErrorContext for
     296             :          * next time.
     297             :          */
     298           0 :         MemoryContextSwitchTo(checkpointer_context);
     299           0 :         FlushErrorState();
     300             : 
     301             :         /* Flush any leaked data in the top-level context */
     302           0 :         MemoryContextResetAndDeleteChildren(checkpointer_context);
     303             : 
     304             :         /* Now we can allow interrupts again */
     305           0 :         RESUME_INTERRUPTS();
     306             : 
     307             :         /*
     308             :          * Sleep at least 1 second after any error.  A write error is likely
     309             :          * to be repeated, and we don't want to be filling the error logs as
     310             :          * fast as we can.
     311             :          */
     312           0 :         pg_usleep(1000000L);
     313             : 
     314             :         /*
     315             :          * Close all open files after any error.  This is helpful on Windows,
     316             :          * where holding deleted files open causes various strange errors.
     317             :          * It's not clear we need it elsewhere, but shouldn't hurt.
     318             :          */
     319           0 :         smgrcloseall();
     320             :     }
     321             : 
     322             :     /* We can now handle ereport(ERROR) */
     323         694 :     PG_exception_stack = &local_sigjmp_buf;
     324             : 
     325             :     /*
     326             :      * Unblock signals (they were blocked when the postmaster forked us)
     327             :      */
     328         694 :     sigprocmask(SIG_SETMASK, &UnBlockSig, NULL);
     329             : 
     330             :     /*
     331             :      * Ensure all shared memory values are set correctly for the config. Doing
     332             :      * this here ensures no race conditions from other concurrent updaters.
     333             :      */
     334         694 :     UpdateSharedMemoryConfig();
     335             : 
     336             :     /*
     337             :      * Advertise our latch that backends can use to wake us up while we're
     338             :      * sleeping.
     339             :      */
     340         694 :     ProcGlobal->checkpointerLatch = &MyProc->procLatch;
     341             : 
     342             :     /*
     343             :      * Loop forever
     344             :      */
     345             :     for (;;)
     346        9042 :     {
     347        9736 :         bool        do_checkpoint = false;
     348        9736 :         int         flags = 0;
     349             :         pg_time_t   now;
     350             :         int         elapsed_secs;
     351             :         int         cur_timeout;
     352             : 
     353             :         /* Clear any already-pending wakeups */
     354        9736 :         ResetLatch(MyLatch);
     355             : 
     356             :         /*
     357             :          * Process any requests or signals received recently.
     358             :          */
     359        9736 :         AbsorbSyncRequests();
     360        9736 :         HandleCheckpointerInterrupts();
     361             : 
     362             :         /*
     363             :          * Detect a pending checkpoint request by checking whether the flags
     364             :          * word in shared memory is nonzero.  We shouldn't need to acquire the
     365             :          * ckpt_lck for this.
     366             :          */
     367        9066 :         if (((volatile CheckpointerShmemStruct *) CheckpointerShmem)->ckpt_flags)
     368             :         {
     369         432 :             do_checkpoint = true;
     370         432 :             PendingCheckpointerStats.requested_checkpoints++;
     371             :         }
     372             : 
     373             :         /*
     374             :          * Force a checkpoint if too much time has elapsed since the last one.
     375             :          * Note that we count a timed checkpoint in stats only when this
     376             :          * occurs without an external request, but we set the CAUSE_TIME flag
     377             :          * bit even if there is also an external request.
     378             :          */
     379        9066 :         now = (pg_time_t) time(NULL);
     380        9066 :         elapsed_secs = now - last_checkpoint_time;
     381        9066 :         if (elapsed_secs >= CheckPointTimeout)
     382             :         {
     383           0 :             if (!do_checkpoint)
     384           0 :                 PendingCheckpointerStats.timed_checkpoints++;
     385           0 :             do_checkpoint = true;
     386           0 :             flags |= CHECKPOINT_CAUSE_TIME;
     387             :         }
     388             : 
     389             :         /*
     390             :          * Do a checkpoint if requested.
     391             :          */
     392        9066 :         if (do_checkpoint)
     393             :         {
     394         432 :             bool        ckpt_performed = false;
     395             :             bool        do_restartpoint;
     396             : 
     397             :             /* Check if we should perform a checkpoint or a restartpoint. */
     398         432 :             do_restartpoint = RecoveryInProgress();
     399             : 
     400             :             /*
     401             :              * Atomically fetch the request flags to figure out what kind of a
     402             :              * checkpoint we should perform, and increase the started-counter
     403             :              * to acknowledge that we've started a new checkpoint.
     404             :              */
     405         432 :             SpinLockAcquire(&CheckpointerShmem->ckpt_lck);
     406         432 :             flags |= CheckpointerShmem->ckpt_flags;
     407         432 :             CheckpointerShmem->ckpt_flags = 0;
     408         432 :             CheckpointerShmem->ckpt_started++;
     409         432 :             SpinLockRelease(&CheckpointerShmem->ckpt_lck);
     410             : 
     411         432 :             ConditionVariableBroadcast(&CheckpointerShmem->start_cv);
     412             : 
     413             :             /*
     414             :              * The end-of-recovery checkpoint is a real checkpoint that's
     415             :              * performed while we're still in recovery.
     416             :              */
     417         432 :             if (flags & CHECKPOINT_END_OF_RECOVERY)
     418          36 :                 do_restartpoint = false;
     419             : 
     420             :             /*
     421             :              * We will warn if (a) too soon since last checkpoint (whatever
     422             :              * caused it) and (b) somebody set the CHECKPOINT_CAUSE_XLOG flag
     423             :              * since the last checkpoint start.  Note in particular that this
     424             :              * implementation will not generate warnings caused by
     425             :              * CheckPointTimeout < CheckPointWarning.
     426             :              */
     427         432 :             if (!do_restartpoint &&
     428         360 :                 (flags & CHECKPOINT_CAUSE_XLOG) &&
     429          60 :                 elapsed_secs < CheckPointWarning)
     430          60 :                 ereport(LOG,
     431             :                         (errmsg_plural("checkpoints are occurring too frequently (%d second apart)",
     432             :                                        "checkpoints are occurring too frequently (%d seconds apart)",
     433             :                                        elapsed_secs,
     434             :                                        elapsed_secs),
     435             :                          errhint("Consider increasing the configuration parameter \"max_wal_size\".")));
     436             : 
     437             :             /*
     438             :              * Initialize checkpointer-private variables used during
     439             :              * checkpoint.
     440             :              */
     441         432 :             ckpt_active = true;
     442         432 :             if (do_restartpoint)
     443          72 :                 ckpt_start_recptr = GetXLogReplayRecPtr(NULL);
     444             :             else
     445         360 :                 ckpt_start_recptr = GetInsertRecPtr();
     446         432 :             ckpt_start_time = now;
     447         432 :             ckpt_cached_elapsed = 0;
     448             : 
     449             :             /*
     450             :              * Do the checkpoint.
     451             :              */
     452         432 :             if (!do_restartpoint)
     453             :             {
     454         360 :                 CreateCheckPoint(flags);
     455         360 :                 ckpt_performed = true;
     456             :             }
     457             :             else
     458          72 :                 ckpt_performed = CreateRestartPoint(flags);
     459             : 
     460             :             /*
     461             :              * After any checkpoint, close all smgr files.  This is so we
     462             :              * won't hang onto smgr references to deleted files indefinitely.
     463             :              */
     464         432 :             smgrcloseall();
     465             : 
     466             :             /*
     467             :              * Indicate checkpoint completion to any waiting backends.
     468             :              */
     469         432 :             SpinLockAcquire(&CheckpointerShmem->ckpt_lck);
     470         432 :             CheckpointerShmem->ckpt_done = CheckpointerShmem->ckpt_started;
     471         432 :             SpinLockRelease(&CheckpointerShmem->ckpt_lck);
     472             : 
     473         432 :             ConditionVariableBroadcast(&CheckpointerShmem->done_cv);
     474             : 
     475         432 :             if (ckpt_performed)
     476             :             {
     477             :                 /*
     478             :                  * Note we record the checkpoint start time not end time as
     479             :                  * last_checkpoint_time.  This is so that time-driven
     480             :                  * checkpoints happen at a predictable spacing.
     481             :                  */
     482         392 :                 last_checkpoint_time = now;
     483             :             }
     484             :             else
     485             :             {
     486             :                 /*
     487             :                  * We were not able to perform the restartpoint (checkpoints
     488             :                  * throw an ERROR in case of error).  Most likely because we
     489             :                  * have not received any new checkpoint WAL records since the
     490             :                  * last restartpoint. Try again in 15 s.
     491             :                  */
     492          40 :                 last_checkpoint_time = now - CheckPointTimeout + 15;
     493             :             }
     494             : 
     495         432 :             ckpt_active = false;
     496             : 
     497             :             /* We may have received an interrupt during the checkpoint. */
     498         432 :             HandleCheckpointerInterrupts();
     499             :         }
     500             : 
     501             :         /* Check for archive_timeout and switch xlog files if necessary. */
     502        9048 :         CheckArchiveTimeout();
     503             : 
     504             :         /* Report pending statistics to the cumulative stats system */
     505        9048 :         pgstat_report_checkpointer();
     506        9048 :         pgstat_report_wal(true);
     507             : 
     508             :         /*
     509             :          * If any checkpoint flags have been set, redo the loop to handle the
     510             :          * checkpoint without sleeping.
     511             :          */
     512        9048 :         if (((volatile CheckpointerShmemStruct *) CheckpointerShmem)->ckpt_flags)
     513          34 :             continue;
     514             : 
     515             :         /*
     516             :          * Sleep until we are signaled or it's time for another checkpoint or
     517             :          * xlog file switch.
     518             :          */
     519        9014 :         now = (pg_time_t) time(NULL);
     520        9014 :         elapsed_secs = now - last_checkpoint_time;
     521        9014 :         if (elapsed_secs >= CheckPointTimeout)
     522           0 :             continue;           /* no sleep for us ... */
     523        9014 :         cur_timeout = CheckPointTimeout - elapsed_secs;
     524        9014 :         if (XLogArchiveTimeout > 0 && !RecoveryInProgress())
     525             :         {
     526           0 :             elapsed_secs = now - last_xlog_switch_time;
     527           0 :             if (elapsed_secs >= XLogArchiveTimeout)
     528           0 :                 continue;       /* no sleep for us ... */
     529           0 :             cur_timeout = Min(cur_timeout, XLogArchiveTimeout - elapsed_secs);
     530             :         }
     531             : 
     532        9014 :         (void) WaitLatch(MyLatch,
     533             :                          WL_LATCH_SET | WL_TIMEOUT | WL_EXIT_ON_PM_DEATH,
     534             :                          cur_timeout * 1000L /* convert to ms */ ,
     535             :                          WAIT_EVENT_CHECKPOINTER_MAIN);
     536             :     }
     537             : }
     538             : 
     539             : /*
     540             :  * Process any new interrupts.
     541             :  */
     542             : static void
     543       10168 : HandleCheckpointerInterrupts(void)
     544             : {
     545       10168 :     if (ProcSignalBarrierPending)
     546          72 :         ProcessProcSignalBarrier();
     547             : 
     548       10168 :     if (ConfigReloadPending)
     549             :     {
     550          70 :         ConfigReloadPending = false;
     551          70 :         ProcessConfigFile(PGC_SIGHUP);
     552             : 
     553             :         /*
     554             :          * Checkpointer is the last process to shut down, so we ask it to hold
     555             :          * the keys for a range of other tasks required most of which have
     556             :          * nothing to do with checkpointing at all.
     557             :          *
     558             :          * For various reasons, some config values can change dynamically so
     559             :          * the primary copy of them is held in shared memory to make sure all
     560             :          * backends see the same value.  We make Checkpointer responsible for
     561             :          * updating the shared memory copy if the parameter setting changes
     562             :          * because of SIGHUP.
     563             :          */
     564          70 :         UpdateSharedMemoryConfig();
     565             :     }
     566       10168 :     if (ShutdownRequestPending)
     567             :     {
     568             :         /*
     569             :          * From here on, elog(ERROR) should end with exit(1), not send control
     570             :          * back to the sigsetjmp block above
     571             :          */
     572         688 :         ExitOnAnyError = true;
     573             : 
     574             :         /*
     575             :          * Close down the database.
     576             :          *
     577             :          * Since ShutdownXLOG() creates restartpoint or checkpoint, and
     578             :          * updates the statistics, increment the checkpoint request and flush
     579             :          * out pending statistic.
     580             :          */
     581         688 :         PendingCheckpointerStats.requested_checkpoints++;
     582         688 :         ShutdownXLOG(0, 0);
     583         688 :         pgstat_report_checkpointer();
     584         688 :         pgstat_report_wal(true);
     585             : 
     586             :         /* Normal exit from the checkpointer is here */
     587         688 :         proc_exit(0);           /* done */
     588             :     }
     589             : 
     590             :     /* Perform logging of memory contexts of this process */
     591        9480 :     if (LogMemoryContextPending)
     592           4 :         ProcessLogMemoryContextInterrupt();
     593        9480 : }
     594             : 
     595             : /*
     596             :  * CheckArchiveTimeout -- check for archive_timeout and switch xlog files
     597             :  *
     598             :  * This will switch to a new WAL file and force an archive file write if
     599             :  * meaningful activity is recorded in the current WAL file. This includes most
     600             :  * writes, including just a single checkpoint record, but excludes WAL records
     601             :  * that were inserted with the XLOG_MARK_UNIMPORTANT flag being set (like
     602             :  * snapshots of running transactions).  Such records, depending on
     603             :  * configuration, occur on regular intervals and don't contain important
     604             :  * information.  This avoids generating archives with a few unimportant
     605             :  * records.
     606             :  */
     607             : static void
     608       12134 : CheckArchiveTimeout(void)
     609             : {
     610             :     pg_time_t   now;
     611             :     pg_time_t   last_time;
     612             :     XLogRecPtr  last_switch_lsn;
     613             : 
     614       12134 :     if (XLogArchiveTimeout <= 0 || RecoveryInProgress())
     615       12134 :         return;
     616             : 
     617           0 :     now = (pg_time_t) time(NULL);
     618             : 
     619             :     /* First we do a quick check using possibly-stale local state. */
     620           0 :     if ((int) (now - last_xlog_switch_time) < XLogArchiveTimeout)
     621           0 :         return;
     622             : 
     623             :     /*
     624             :      * Update local state ... note that last_xlog_switch_time is the last time
     625             :      * a switch was performed *or requested*.
     626             :      */
     627           0 :     last_time = GetLastSegSwitchData(&last_switch_lsn);
     628             : 
     629           0 :     last_xlog_switch_time = Max(last_xlog_switch_time, last_time);
     630             : 
     631             :     /* Now we can do the real checks */
     632           0 :     if ((int) (now - last_xlog_switch_time) >= XLogArchiveTimeout)
     633             :     {
     634             :         /*
     635             :          * Switch segment only when "important" WAL has been logged since the
     636             :          * last segment switch (last_switch_lsn points to end of segment
     637             :          * switch occurred in).
     638             :          */
     639           0 :         if (GetLastImportantRecPtr() > last_switch_lsn)
     640             :         {
     641             :             XLogRecPtr  switchpoint;
     642             : 
     643             :             /* mark switch as unimportant, avoids triggering checkpoints */
     644           0 :             switchpoint = RequestXLogSwitch(true);
     645             : 
     646             :             /*
     647             :              * If the returned pointer points exactly to a segment boundary,
     648             :              * assume nothing happened.
     649             :              */
     650           0 :             if (XLogSegmentOffset(switchpoint, wal_segment_size) != 0)
     651           0 :                 elog(DEBUG1, "write-ahead log switch forced (archive_timeout=%d)",
     652             :                      XLogArchiveTimeout);
     653             :         }
     654             : 
     655             :         /*
     656             :          * Update state in any case, so we don't retry constantly when the
     657             :          * system is idle.
     658             :          */
     659           0 :         last_xlog_switch_time = now;
     660             :     }
     661             : }
     662             : 
     663             : /*
     664             :  * Returns true if an immediate checkpoint request is pending.  (Note that
     665             :  * this does not check the *current* checkpoint's IMMEDIATE flag, but whether
     666             :  * there is one pending behind it.)
     667             :  */
     668             : static bool
     669       44802 : ImmediateCheckpointRequested(void)
     670             : {
     671       44802 :     volatile CheckpointerShmemStruct *cps = CheckpointerShmem;
     672             : 
     673             :     /*
     674             :      * We don't need to acquire the ckpt_lck in this case because we're only
     675             :      * looking at a single flag bit.
     676             :      */
     677       44802 :     if (cps->ckpt_flags & CHECKPOINT_IMMEDIATE)
     678        1146 :         return true;
     679       43656 :     return false;
     680             : }
     681             : 
     682             : /*
     683             :  * CheckpointWriteDelay -- control rate of checkpoint
     684             :  *
     685             :  * This function is called after each page write performed by BufferSync().
     686             :  * It is responsible for throttling BufferSync()'s write rate to hit
     687             :  * checkpoint_completion_target.
     688             :  *
     689             :  * The checkpoint request flags should be passed in; currently the only one
     690             :  * examined is CHECKPOINT_IMMEDIATE, which disables delays between writes.
     691             :  *
     692             :  * 'progress' is an estimate of how much of the work has been done, as a
     693             :  * fraction between 0.0 meaning none, and 1.0 meaning all done.
     694             :  */
     695             : void
     696      929584 : CheckpointWriteDelay(int flags, double progress)
     697             : {
     698             :     static int  absorb_counter = WRITES_PER_ABSORB;
     699             : 
     700             :     /* Do nothing if checkpoint is being executed by non-checkpointer process */
     701      929584 :     if (!AmCheckpointerProcess())
     702      609522 :         return;
     703             : 
     704             :     /*
     705             :      * Perform the usual duties and take a nap, unless we're behind schedule,
     706             :      * in which case we just try to catch up as quickly as possible.
     707             :      */
     708      320062 :     if (!(flags & CHECKPOINT_IMMEDIATE) &&
     709       49858 :         !ShutdownRequestPending &&
     710       88458 :         !ImmediateCheckpointRequested() &&
     711       43656 :         IsCheckpointOnSchedule(progress))
     712             :     {
     713        3086 :         if (ConfigReloadPending)
     714             :         {
     715           2 :             ConfigReloadPending = false;
     716           2 :             ProcessConfigFile(PGC_SIGHUP);
     717             :             /* update shmem copies of config variables */
     718           2 :             UpdateSharedMemoryConfig();
     719             :         }
     720             : 
     721        3086 :         AbsorbSyncRequests();
     722        3086 :         absorb_counter = WRITES_PER_ABSORB;
     723             : 
     724        3086 :         CheckArchiveTimeout();
     725             : 
     726             :         /* Report interim statistics to the cumulative stats system */
     727        3086 :         pgstat_report_checkpointer();
     728             : 
     729             :         /*
     730             :          * This sleep used to be connected to bgwriter_delay, typically 200ms.
     731             :          * That resulted in more frequent wakeups if not much work to do.
     732             :          * Checkpointer and bgwriter are no longer related so take the Big
     733             :          * Sleep.
     734             :          */
     735        3086 :         WaitLatch(MyLatch, WL_LATCH_SET | WL_EXIT_ON_PM_DEATH | WL_TIMEOUT,
     736             :                   100,
     737             :                   WAIT_EVENT_CHECKPOINT_WRITE_DELAY);
     738        3086 :         ResetLatch(MyLatch);
     739             :     }
     740      316976 :     else if (--absorb_counter <= 0)
     741             :     {
     742             :         /*
     743             :          * Absorb pending fsync requests after each WRITES_PER_ABSORB write
     744             :          * operations even when we don't sleep, to prevent overflow of the
     745             :          * fsync request queue.
     746             :          */
     747         124 :         AbsorbSyncRequests();
     748         124 :         absorb_counter = WRITES_PER_ABSORB;
     749             :     }
     750             : 
     751             :     /* Check for barrier events. */
     752      320062 :     if (ProcSignalBarrierPending)
     753           4 :         ProcessProcSignalBarrier();
     754             : }
     755             : 
     756             : /*
     757             :  * IsCheckpointOnSchedule -- are we on schedule to finish this checkpoint
     758             :  *       (or restartpoint) in time?
     759             :  *
     760             :  * Compares the current progress against the time/segments elapsed since last
     761             :  * checkpoint, and returns true if the progress we've made this far is greater
     762             :  * than the elapsed time/segments.
     763             :  */
     764             : static bool
     765       43656 : IsCheckpointOnSchedule(double progress)
     766             : {
     767             :     XLogRecPtr  recptr;
     768             :     struct timeval now;
     769             :     double      elapsed_xlogs,
     770             :                 elapsed_time;
     771             : 
     772             :     Assert(ckpt_active);
     773             : 
     774             :     /* Scale progress according to checkpoint_completion_target. */
     775       43656 :     progress *= CheckPointCompletionTarget;
     776             : 
     777             :     /*
     778             :      * Check against the cached value first. Only do the more expensive
     779             :      * calculations once we reach the target previously calculated. Since
     780             :      * neither time or WAL insert pointer moves backwards, a freshly
     781             :      * calculated value can only be greater than or equal to the cached value.
     782             :      */
     783       43656 :     if (progress < ckpt_cached_elapsed)
     784       39672 :         return false;
     785             : 
     786             :     /*
     787             :      * Check progress against WAL segments written and CheckPointSegments.
     788             :      *
     789             :      * We compare the current WAL insert location against the location
     790             :      * computed before calling CreateCheckPoint. The code in XLogInsert that
     791             :      * actually triggers a checkpoint when CheckPointSegments is exceeded
     792             :      * compares against RedoRecPtr, so this is not completely accurate.
     793             :      * However, it's good enough for our purposes, we're only calculating an
     794             :      * estimate anyway.
     795             :      *
     796             :      * During recovery, we compare last replayed WAL record's location with
     797             :      * the location computed before calling CreateRestartPoint. That maintains
     798             :      * the same pacing as we have during checkpoints in normal operation, but
     799             :      * we might exceed max_wal_size by a fair amount. That's because there can
     800             :      * be a large gap between a checkpoint's redo-pointer and the checkpoint
     801             :      * record itself, and we only start the restartpoint after we've seen the
     802             :      * checkpoint record. (The gap is typically up to CheckPointSegments *
     803             :      * checkpoint_completion_target where checkpoint_completion_target is the
     804             :      * value that was in effect when the WAL was generated).
     805             :      */
     806        3984 :     if (RecoveryInProgress())
     807        1030 :         recptr = GetXLogReplayRecPtr(NULL);
     808             :     else
     809        2954 :         recptr = GetInsertRecPtr();
     810        3984 :     elapsed_xlogs = (((double) (recptr - ckpt_start_recptr)) /
     811        3984 :                      wal_segment_size) / CheckPointSegments;
     812             : 
     813        3984 :     if (progress < elapsed_xlogs)
     814             :     {
     815         898 :         ckpt_cached_elapsed = elapsed_xlogs;
     816         898 :         return false;
     817             :     }
     818             : 
     819             :     /*
     820             :      * Check progress against time elapsed and checkpoint_timeout.
     821             :      */
     822        3086 :     gettimeofday(&now, NULL);
     823        3086 :     elapsed_time = ((double) ((pg_time_t) now.tv_sec - ckpt_start_time) +
     824        3086 :                     now.tv_usec / 1000000.0) / CheckPointTimeout;
     825             : 
     826        3086 :     if (progress < elapsed_time)
     827             :     {
     828           0 :         ckpt_cached_elapsed = elapsed_time;
     829           0 :         return false;
     830             :     }
     831             : 
     832             :     /* It looks like we're on schedule. */
     833        3086 :     return true;
     834             : }
     835             : 
     836             : 
     837             : /* --------------------------------
     838             :  *      signal handler routines
     839             :  * --------------------------------
     840             :  */
     841             : 
     842             : /* SIGINT: set flag to run a normal checkpoint right away */
     843             : static void
     844         438 : ReqCheckpointHandler(SIGNAL_ARGS)
     845             : {
     846         438 :     int         save_errno = errno;
     847             : 
     848             :     /*
     849             :      * The signaling process should have set ckpt_flags nonzero, so all we
     850             :      * need do is ensure that our main loop gets kicked out of any wait.
     851             :      */
     852         438 :     SetLatch(MyLatch);
     853             : 
     854         438 :     errno = save_errno;
     855         438 : }
     856             : 
     857             : 
     858             : /* --------------------------------
     859             :  *      communication with backends
     860             :  * --------------------------------
     861             :  */
     862             : 
     863             : /*
     864             :  * CheckpointerShmemSize
     865             :  *      Compute space needed for checkpointer-related shared memory
     866             :  */
     867             : Size
     868        9092 : CheckpointerShmemSize(void)
     869             : {
     870             :     Size        size;
     871             : 
     872             :     /*
     873             :      * Currently, the size of the requests[] array is arbitrarily set equal to
     874             :      * NBuffers.  This may prove too large or small ...
     875             :      */
     876        9092 :     size = offsetof(CheckpointerShmemStruct, requests);
     877        9092 :     size = add_size(size, mul_size(NBuffers, sizeof(CheckpointerRequest)));
     878             : 
     879        9092 :     return size;
     880             : }
     881             : 
     882             : /*
     883             :  * CheckpointerShmemInit
     884             :  *      Allocate and initialize checkpointer-related shared memory
     885             :  */
     886             : void
     887        3636 : CheckpointerShmemInit(void)
     888             : {
     889        3636 :     Size        size = CheckpointerShmemSize();
     890             :     bool        found;
     891             : 
     892        3636 :     CheckpointerShmem = (CheckpointerShmemStruct *)
     893        3636 :         ShmemInitStruct("Checkpointer Data",
     894             :                         size,
     895             :                         &found);
     896             : 
     897        3636 :     if (!found)
     898             :     {
     899             :         /*
     900             :          * First time through, so initialize.  Note that we zero the whole
     901             :          * requests array; this is so that CompactCheckpointerRequestQueue can
     902             :          * assume that any pad bytes in the request structs are zeroes.
     903             :          */
     904        4276 :         MemSet(CheckpointerShmem, 0, size);
     905        3636 :         SpinLockInit(&CheckpointerShmem->ckpt_lck);
     906        3636 :         CheckpointerShmem->max_requests = NBuffers;
     907        3636 :         ConditionVariableInit(&CheckpointerShmem->start_cv);
     908        3636 :         ConditionVariableInit(&CheckpointerShmem->done_cv);
     909             :     }
     910        3636 : }
     911             : 
     912             : /*
     913             :  * RequestCheckpoint
     914             :  *      Called in backend processes to request a checkpoint
     915             :  *
     916             :  * flags is a bitwise OR of the following:
     917             :  *  CHECKPOINT_IS_SHUTDOWN: checkpoint is for database shutdown.
     918             :  *  CHECKPOINT_END_OF_RECOVERY: checkpoint is for end of WAL recovery.
     919             :  *  CHECKPOINT_IMMEDIATE: finish the checkpoint ASAP,
     920             :  *      ignoring checkpoint_completion_target parameter.
     921             :  *  CHECKPOINT_FORCE: force a checkpoint even if no XLOG activity has occurred
     922             :  *      since the last one (implied by CHECKPOINT_IS_SHUTDOWN or
     923             :  *      CHECKPOINT_END_OF_RECOVERY).
     924             :  *  CHECKPOINT_WAIT: wait for completion before returning (otherwise,
     925             :  *      just signal checkpointer to do it, and return).
     926             :  *  CHECKPOINT_CAUSE_XLOG: checkpoint is requested due to xlog filling.
     927             :  *      (This affects logging, and in particular enables CheckPointWarning.)
     928             :  */
     929             : void
     930        3300 : RequestCheckpoint(int flags)
     931             : {
     932             :     int         ntries;
     933             :     int         old_failed,
     934             :                 old_started;
     935             : 
     936             :     /*
     937             :      * If in a standalone backend, just do it ourselves.
     938             :      */
     939        3300 :     if (!IsPostmasterEnvironment)
     940             :     {
     941             :         /*
     942             :          * There's no point in doing slow checkpoints in a standalone backend,
     943             :          * because there's no other backends the checkpoint could disrupt.
     944             :          */
     945        2426 :         CreateCheckPoint(flags | CHECKPOINT_IMMEDIATE);
     946             : 
     947             :         /*
     948             :          * After any checkpoint, close all smgr files.  This is so we won't
     949             :          * hang onto smgr references to deleted files indefinitely.
     950             :          */
     951        2426 :         smgrcloseall();
     952             : 
     953        2426 :         return;
     954             :     }
     955             : 
     956             :     /*
     957             :      * Atomically set the request flags, and take a snapshot of the counters.
     958             :      * When we see ckpt_started > old_started, we know the flags we set here
     959             :      * have been seen by checkpointer.
     960             :      *
     961             :      * Note that we OR the flags with any existing flags, to avoid overriding
     962             :      * a "stronger" request by another backend.  The flag senses must be
     963             :      * chosen to make this work!
     964             :      */
     965         874 :     SpinLockAcquire(&CheckpointerShmem->ckpt_lck);
     966             : 
     967         874 :     old_failed = CheckpointerShmem->ckpt_failed;
     968         874 :     old_started = CheckpointerShmem->ckpt_started;
     969         874 :     CheckpointerShmem->ckpt_flags |= (flags | CHECKPOINT_REQUESTED);
     970             : 
     971         874 :     SpinLockRelease(&CheckpointerShmem->ckpt_lck);
     972             : 
     973             :     /*
     974             :      * Send signal to request checkpoint.  It's possible that the checkpointer
     975             :      * hasn't started yet, or is in process of restarting, so we will retry a
     976             :      * few times if needed.  (Actually, more than a few times, since on slow
     977             :      * or overloaded buildfarm machines, it's been observed that the
     978             :      * checkpointer can take several seconds to start.)  However, if not told
     979             :      * to wait for the checkpoint to occur, we consider failure to send the
     980             :      * signal to be nonfatal and merely LOG it.  The checkpointer should see
     981             :      * the request when it does start, with or without getting a signal.
     982             :      */
     983             : #define MAX_SIGNAL_TRIES 600    /* max wait 60.0 sec */
     984         882 :     for (ntries = 0;; ntries++)
     985             :     {
     986         882 :         if (CheckpointerShmem->checkpointer_pid == 0)
     987             :         {
     988           8 :             if (ntries >= MAX_SIGNAL_TRIES || !(flags & CHECKPOINT_WAIT))
     989             :             {
     990           0 :                 elog((flags & CHECKPOINT_WAIT) ? ERROR : LOG,
     991             :                      "could not signal for checkpoint: checkpointer is not running");
     992           0 :                 break;
     993             :             }
     994             :         }
     995         874 :         else if (kill(CheckpointerShmem->checkpointer_pid, SIGINT) != 0)
     996             :         {
     997           0 :             if (ntries >= MAX_SIGNAL_TRIES || !(flags & CHECKPOINT_WAIT))
     998             :             {
     999           0 :                 elog((flags & CHECKPOINT_WAIT) ? ERROR : LOG,
    1000             :                      "could not signal for checkpoint: %m");
    1001           0 :                 break;
    1002             :             }
    1003             :         }
    1004             :         else
    1005         874 :             break;              /* signal sent successfully */
    1006             : 
    1007           8 :         CHECK_FOR_INTERRUPTS();
    1008           8 :         pg_usleep(100000L);     /* wait 0.1 sec, then retry */
    1009             :     }
    1010             : 
    1011             :     /*
    1012             :      * If requested, wait for completion.  We detect completion according to
    1013             :      * the algorithm given above.
    1014             :      */
    1015         874 :     if (flags & CHECKPOINT_WAIT)
    1016             :     {
    1017             :         int         new_started,
    1018             :                     new_failed;
    1019             : 
    1020             :         /* Wait for a new checkpoint to start. */
    1021         672 :         ConditionVariablePrepareToSleep(&CheckpointerShmem->start_cv);
    1022             :         for (;;)
    1023             :         {
    1024        1228 :             SpinLockAcquire(&CheckpointerShmem->ckpt_lck);
    1025        1228 :             new_started = CheckpointerShmem->ckpt_started;
    1026        1228 :             SpinLockRelease(&CheckpointerShmem->ckpt_lck);
    1027             : 
    1028        1228 :             if (new_started != old_started)
    1029         672 :                 break;
    1030             : 
    1031         556 :             ConditionVariableSleep(&CheckpointerShmem->start_cv,
    1032             :                                    WAIT_EVENT_CHECKPOINT_START);
    1033             :         }
    1034         672 :         ConditionVariableCancelSleep();
    1035             : 
    1036             :         /*
    1037             :          * We are waiting for ckpt_done >= new_started, in a modulo sense.
    1038             :          */
    1039         672 :         ConditionVariablePrepareToSleep(&CheckpointerShmem->done_cv);
    1040             :         for (;;)
    1041         476 :         {
    1042             :             int         new_done;
    1043             : 
    1044        1148 :             SpinLockAcquire(&CheckpointerShmem->ckpt_lck);
    1045        1148 :             new_done = CheckpointerShmem->ckpt_done;
    1046        1148 :             new_failed = CheckpointerShmem->ckpt_failed;
    1047        1148 :             SpinLockRelease(&CheckpointerShmem->ckpt_lck);
    1048             : 
    1049        1148 :             if (new_done - new_started >= 0)
    1050         672 :                 break;
    1051             : 
    1052         476 :             ConditionVariableSleep(&CheckpointerShmem->done_cv,
    1053             :                                    WAIT_EVENT_CHECKPOINT_DONE);
    1054             :         }
    1055         672 :         ConditionVariableCancelSleep();
    1056             : 
    1057         672 :         if (new_failed != old_failed)
    1058           0 :             ereport(ERROR,
    1059             :                     (errmsg("checkpoint request failed"),
    1060             :                      errhint("Consult recent messages in the server log for details.")));
    1061             :     }
    1062             : }
    1063             : 
    1064             : /*
    1065             :  * ForwardSyncRequest
    1066             :  *      Forward a file-fsync request from a backend to the checkpointer
    1067             :  *
    1068             :  * Whenever a backend is compelled to write directly to a relation
    1069             :  * (which should be seldom, if the background writer is getting its job done),
    1070             :  * the backend calls this routine to pass over knowledge that the relation
    1071             :  * is dirty and must be fsync'd before next checkpoint.  We also use this
    1072             :  * opportunity to count such writes for statistical purposes.
    1073             :  *
    1074             :  * To avoid holding the lock for longer than necessary, we normally write
    1075             :  * to the requests[] queue without checking for duplicates.  The checkpointer
    1076             :  * will have to eliminate dups internally anyway.  However, if we discover
    1077             :  * that the queue is full, we make a pass over the entire queue to compact
    1078             :  * it.  This is somewhat expensive, but the alternative is for the backend
    1079             :  * to perform its own fsync, which is far more expensive in practice.  It
    1080             :  * is theoretically possible a backend fsync might still be necessary, if
    1081             :  * the queue is full and contains no duplicate entries.  In that case, we
    1082             :  * let the backend know by returning false.
    1083             :  */
    1084             : bool
    1085     1043118 : ForwardSyncRequest(const FileTag *ftag, SyncRequestType type)
    1086             : {
    1087             :     CheckpointerRequest *request;
    1088             :     bool        too_full;
    1089             : 
    1090     1043118 :     if (!IsUnderPostmaster)
    1091           0 :         return false;           /* probably shouldn't even get here */
    1092             : 
    1093     1043118 :     if (AmCheckpointerProcess())
    1094           0 :         elog(ERROR, "ForwardSyncRequest must not be called in checkpointer");
    1095             : 
    1096     1043118 :     LWLockAcquire(CheckpointerCommLock, LW_EXCLUSIVE);
    1097             : 
    1098             :     /* Count all backend writes regardless of if they fit in the queue */
    1099     1043118 :     if (!AmBackgroundWriterProcess())
    1100     1020574 :         CheckpointerShmem->num_backend_writes++;
    1101             : 
    1102             :     /*
    1103             :      * If the checkpointer isn't running or the request queue is full, the
    1104             :      * backend will have to perform its own fsync request.  But before forcing
    1105             :      * that to happen, we can try to compact the request queue.
    1106             :      */
    1107     1043118 :     if (CheckpointerShmem->checkpointer_pid == 0 ||
    1108     1043118 :         (CheckpointerShmem->num_requests >= CheckpointerShmem->max_requests &&
    1109         448 :          !CompactCheckpointerRequestQueue()))
    1110             :     {
    1111             :         /*
    1112             :          * Count the subset of writes where backends have to do their own
    1113             :          * fsync
    1114             :          */
    1115           4 :         if (!AmBackgroundWriterProcess())
    1116           4 :             CheckpointerShmem->num_backend_fsync++;
    1117           4 :         LWLockRelease(CheckpointerCommLock);
    1118           4 :         return false;
    1119             :     }
    1120             : 
    1121             :     /* OK, insert request */
    1122     1043114 :     request = &CheckpointerShmem->requests[CheckpointerShmem->num_requests++];
    1123     1043114 :     request->ftag = *ftag;
    1124     1043114 :     request->type = type;
    1125             : 
    1126             :     /* If queue is more than half full, nudge the checkpointer to empty it */
    1127     1043114 :     too_full = (CheckpointerShmem->num_requests >=
    1128     1043114 :                 CheckpointerShmem->max_requests / 2);
    1129             : 
    1130     1043114 :     LWLockRelease(CheckpointerCommLock);
    1131             : 
    1132             :     /* ... but not till after we release the lock */
    1133     1043114 :     if (too_full && ProcGlobal->checkpointerLatch)
    1134       22920 :         SetLatch(ProcGlobal->checkpointerLatch);
    1135             : 
    1136     1043114 :     return true;
    1137             : }
    1138             : 
    1139             : /*
    1140             :  * CompactCheckpointerRequestQueue
    1141             :  *      Remove duplicates from the request queue to avoid backend fsyncs.
    1142             :  *      Returns "true" if any entries were removed.
    1143             :  *
    1144             :  * Although a full fsync request queue is not common, it can lead to severe
    1145             :  * performance problems when it does happen.  So far, this situation has
    1146             :  * only been observed to occur when the system is under heavy write load,
    1147             :  * and especially during the "sync" phase of a checkpoint.  Without this
    1148             :  * logic, each backend begins doing an fsync for every block written, which
    1149             :  * gets very expensive and can slow down the whole system.
    1150             :  *
    1151             :  * Trying to do this every time the queue is full could lose if there
    1152             :  * aren't any removable entries.  But that should be vanishingly rare in
    1153             :  * practice: there's one queue entry per shared buffer.
    1154             :  */
    1155             : static bool
    1156         448 : CompactCheckpointerRequestQueue(void)
    1157             : {
    1158             :     struct CheckpointerSlotMapping
    1159             :     {
    1160             :         CheckpointerRequest request;
    1161             :         int         slot;
    1162             :     };
    1163             : 
    1164             :     int         n,
    1165             :                 preserve_count;
    1166         448 :     int         num_skipped = 0;
    1167             :     HASHCTL     ctl;
    1168             :     HTAB       *htab;
    1169             :     bool       *skip_slot;
    1170             : 
    1171             :     /* must hold CheckpointerCommLock in exclusive mode */
    1172             :     Assert(LWLockHeldByMe(CheckpointerCommLock));
    1173             : 
    1174             :     /* Initialize skip_slot array */
    1175         448 :     skip_slot = palloc0(sizeof(bool) * CheckpointerShmem->num_requests);
    1176             : 
    1177             :     /* Initialize temporary hash table */
    1178         448 :     ctl.keysize = sizeof(CheckpointerRequest);
    1179         448 :     ctl.entrysize = sizeof(struct CheckpointerSlotMapping);
    1180         448 :     ctl.hcxt = CurrentMemoryContext;
    1181             : 
    1182         448 :     htab = hash_create("CompactCheckpointerRequestQueue",
    1183         448 :                        CheckpointerShmem->num_requests,
    1184             :                        &ctl,
    1185             :                        HASH_ELEM | HASH_BLOBS | HASH_CONTEXT);
    1186             : 
    1187             :     /*
    1188             :      * The basic idea here is that a request can be skipped if it's followed
    1189             :      * by a later, identical request.  It might seem more sensible to work
    1190             :      * backwards from the end of the queue and check whether a request is
    1191             :      * *preceded* by an earlier, identical request, in the hopes of doing less
    1192             :      * copying.  But that might change the semantics, if there's an
    1193             :      * intervening SYNC_FORGET_REQUEST or SYNC_FILTER_REQUEST, so we do it
    1194             :      * this way.  It would be possible to be even smarter if we made the code
    1195             :      * below understand the specific semantics of such requests (it could blow
    1196             :      * away preceding entries that would end up being canceled anyhow), but
    1197             :      * it's not clear that the extra complexity would buy us anything.
    1198             :      */
    1199       11872 :     for (n = 0; n < CheckpointerShmem->num_requests; n++)
    1200             :     {
    1201             :         CheckpointerRequest *request;
    1202             :         struct CheckpointerSlotMapping *slotmap;
    1203             :         bool        found;
    1204             : 
    1205             :         /*
    1206             :          * We use the request struct directly as a hashtable key.  This
    1207             :          * assumes that any padding bytes in the structs are consistently the
    1208             :          * same, which should be okay because we zeroed them in
    1209             :          * CheckpointerShmemInit.  Note also that RelFileLocator had better
    1210             :          * contain no pad bytes.
    1211             :          */
    1212       11424 :         request = &CheckpointerShmem->requests[n];
    1213       11424 :         slotmap = hash_search(htab, request, HASH_ENTER, &found);
    1214       11424 :         if (found)
    1215             :         {
    1216             :             /* Duplicate, so mark the previous occurrence as skippable */
    1217        3426 :             skip_slot[slotmap->slot] = true;
    1218        3426 :             num_skipped++;
    1219             :         }
    1220             :         /* Remember slot containing latest occurrence of this request value */
    1221       11424 :         slotmap->slot = n;
    1222             :     }
    1223             : 
    1224             :     /* Done with the hash table. */
    1225         448 :     hash_destroy(htab);
    1226             : 
    1227             :     /* If no duplicates, we're out of luck. */
    1228         448 :     if (!num_skipped)
    1229             :     {
    1230           4 :         pfree(skip_slot);
    1231           4 :         return false;
    1232             :     }
    1233             : 
    1234             :     /* We found some duplicates; remove them. */
    1235         444 :     preserve_count = 0;
    1236       11356 :     for (n = 0; n < CheckpointerShmem->num_requests; n++)
    1237             :     {
    1238       10912 :         if (skip_slot[n])
    1239        3426 :             continue;
    1240        7486 :         CheckpointerShmem->requests[preserve_count++] = CheckpointerShmem->requests[n];
    1241             :     }
    1242         444 :     ereport(DEBUG1,
    1243             :             (errmsg_internal("compacted fsync request queue from %d entries to %d entries",
    1244             :                              CheckpointerShmem->num_requests, preserve_count)));
    1245         444 :     CheckpointerShmem->num_requests = preserve_count;
    1246             : 
    1247             :     /* Cleanup. */
    1248         444 :     pfree(skip_slot);
    1249         444 :     return true;
    1250             : }
    1251             : 
    1252             : /*
    1253             :  * AbsorbSyncRequests
    1254             :  *      Retrieve queued sync requests and pass them to sync mechanism.
    1255             :  *
    1256             :  * This is exported because it must be called during CreateCheckPoint;
    1257             :  * we have to be sure we have accepted all pending requests just before
    1258             :  * we start fsync'ing.  Since CreateCheckPoint sometimes runs in
    1259             :  * non-checkpointer processes, do nothing if not checkpointer.
    1260             :  */
    1261             : void
    1262       27660 : AbsorbSyncRequests(void)
    1263             : {
    1264       27660 :     CheckpointerRequest *requests = NULL;
    1265             :     CheckpointerRequest *request;
    1266             :     int         n;
    1267             : 
    1268       27660 :     if (!AmCheckpointerProcess())
    1269        7312 :         return;
    1270             : 
    1271       20348 :     LWLockAcquire(CheckpointerCommLock, LW_EXCLUSIVE);
    1272             : 
    1273             :     /* Transfer stats counts into pending pgstats message */
    1274             :     PendingCheckpointerStats.buf_written_backend
    1275       20348 :         += CheckpointerShmem->num_backend_writes;
    1276             :     PendingCheckpointerStats.buf_fsync_backend
    1277       20348 :         += CheckpointerShmem->num_backend_fsync;
    1278             : 
    1279       20348 :     CheckpointerShmem->num_backend_writes = 0;
    1280       20348 :     CheckpointerShmem->num_backend_fsync = 0;
    1281             : 
    1282             :     /*
    1283             :      * We try to avoid holding the lock for a long time by copying the request
    1284             :      * array, and processing the requests after releasing the lock.
    1285             :      *
    1286             :      * Once we have cleared the requests from shared memory, we have to PANIC
    1287             :      * if we then fail to absorb them (eg, because our hashtable runs out of
    1288             :      * memory).  This is because the system cannot run safely if we are unable
    1289             :      * to fsync what we have been told to fsync.  Fortunately, the hashtable
    1290             :      * is so small that the problem is quite unlikely to arise in practice.
    1291             :      */
    1292       20348 :     n = CheckpointerShmem->num_requests;
    1293       20348 :     if (n > 0)
    1294             :     {
    1295       11176 :         requests = (CheckpointerRequest *) palloc(n * sizeof(CheckpointerRequest));
    1296       11176 :         memcpy(requests, CheckpointerShmem->requests, n * sizeof(CheckpointerRequest));
    1297             :     }
    1298             : 
    1299       20348 :     START_CRIT_SECTION();
    1300             : 
    1301       20348 :     CheckpointerShmem->num_requests = 0;
    1302             : 
    1303       20348 :     LWLockRelease(CheckpointerCommLock);
    1304             : 
    1305      926380 :     for (request = requests; n > 0; request++, n--)
    1306      906032 :         RememberSyncRequest(&request->ftag, request->type);
    1307             : 
    1308       20348 :     END_CRIT_SECTION();
    1309             : 
    1310       20348 :     if (requests)
    1311       11176 :         pfree(requests);
    1312             : }
    1313             : 
    1314             : /*
    1315             :  * Update any shared memory configurations based on config parameters
    1316             :  */
    1317             : static void
    1318         766 : UpdateSharedMemoryConfig(void)
    1319             : {
    1320             :     /* update global shmem state for sync rep */
    1321         766 :     SyncRepUpdateSyncStandbysDefined();
    1322             : 
    1323             :     /*
    1324             :      * If full_page_writes has been changed by SIGHUP, we update it in shared
    1325             :      * memory and write an XLOG_FPW_CHANGE record.
    1326             :      */
    1327         766 :     UpdateFullPageWrites();
    1328             : 
    1329         766 :     elog(DEBUG2, "checkpointer updated shared memory configuration values");
    1330         766 : }
    1331             : 
    1332             : /*
    1333             :  * FirstCallSinceLastCheckpoint allows a process to take an action once
    1334             :  * per checkpoint cycle by asynchronously checking for checkpoint completion.
    1335             :  */
    1336             : bool
    1337       13342 : FirstCallSinceLastCheckpoint(void)
    1338             : {
    1339             :     static int  ckpt_done = 0;
    1340             :     int         new_done;
    1341       13342 :     bool        FirstCall = false;
    1342             : 
    1343       13342 :     SpinLockAcquire(&CheckpointerShmem->ckpt_lck);
    1344       13342 :     new_done = CheckpointerShmem->ckpt_done;
    1345       13342 :     SpinLockRelease(&CheckpointerShmem->ckpt_lck);
    1346             : 
    1347       13342 :     if (new_done != ckpt_done)
    1348         302 :         FirstCall = true;
    1349             : 
    1350       13342 :     ckpt_done = new_done;
    1351             : 
    1352       13342 :     return FirstCall;
    1353             : }

Generated by: LCOV version 1.14