syncrep.h File Reference

#include "access/xlogdefs.h"

Include dependency graph for syncrep.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	SyncRepStandbyData
struct	SyncRepConfigData

Macros
#define	SyncRepRequested()    (max_wal_senders > 0 && synchronous_commit > SYNCHRONOUS_COMMIT_LOCAL_FLUSH)
#define	SYNC_REP_NO_WAIT   (-1)
#define	SYNC_REP_WAIT_WRITE   0
#define	SYNC_REP_WAIT_FLUSH   1
#define	SYNC_REP_WAIT_APPLY   2
#define	NUM_SYNC_REP_WAIT_MODE   3
#define	SYNC_REP_NOT_WAITING   0
#define	SYNC_REP_WAITING   1
#define	SYNC_REP_WAIT_COMPLETE   2
#define	SYNC_REP_PRIORITY   0
#define	SYNC_REP_QUORUM   1

Typedefs
typedef struct SyncRepStandbyData	SyncRepStandbyData
typedef struct SyncRepConfigData	SyncRepConfigData
typedef void *	yyscan_t

Functions
void	SyncRepWaitForLSN (XLogRecPtr lsn, bool commit)
void	SyncRepCleanupAtProcExit (void)
void	SyncRepInitConfig (void)
void	SyncRepReleaseWaiters (void)
int	SyncRepGetCandidateStandbys (SyncRepStandbyData **standbys)
void	SyncRepUpdateSyncStandbysDefined (void)
int	syncrep_yyparse (SyncRepConfigData **syncrep_parse_result_p, char **syncrep_parse_error_msg_p, yyscan_t yyscanner)
int	syncrep_yylex (union YYSTYPE *yylval_param, char **syncrep_parse_error_msg_p, yyscan_t yyscanner)
void	syncrep_yyerror (SyncRepConfigData **syncrep_parse_result_p, char **syncrep_parse_error_msg_p, yyscan_t yyscanner, const char *str)
void	syncrep_scanner_init (const char *str, yyscan_t *yyscannerp)
void	syncrep_scanner_finish (yyscan_t yyscanner)

Variables
PGDLLIMPORT SyncRepConfigData *	SyncRepConfig
PGDLLIMPORT char *	SyncRepStandbyNames

Macro Definition Documentation

NUM_SYNC_REP_WAIT_MODE

#define NUM_SYNC_REP_WAIT_MODE   3

Definition at line 27 of file syncrep.h.

SYNC_REP_NO_WAIT

#define SYNC_REP_NO_WAIT   (-1)

Definition at line 22 of file syncrep.h.

SYNC_REP_NOT_WAITING

#define SYNC_REP_NOT_WAITING   0

Definition at line 30 of file syncrep.h.

SYNC_REP_PRIORITY

#define SYNC_REP_PRIORITY   0

Definition at line 35 of file syncrep.h.

SYNC_REP_QUORUM

#define SYNC_REP_QUORUM   1

Definition at line 36 of file syncrep.h.

SYNC_REP_WAIT_APPLY

#define SYNC_REP_WAIT_APPLY   2

Definition at line 25 of file syncrep.h.

SYNC_REP_WAIT_COMPLETE

#define SYNC_REP_WAIT_COMPLETE   2

Definition at line 32 of file syncrep.h.

SYNC_REP_WAIT_FLUSH

#define SYNC_REP_WAIT_FLUSH   1

Definition at line 24 of file syncrep.h.

SYNC_REP_WAIT_WRITE

#define SYNC_REP_WAIT_WRITE   0

Definition at line 23 of file syncrep.h.

SYNC_REP_WAITING

#define SYNC_REP_WAITING   1

Definition at line 31 of file syncrep.h.

SyncRepRequested

#define SyncRepRequested

(

)

(max_wal_senders > 0 && synchronous_commit > SYNCHRONOUS_COMMIT_LOCAL_FLUSH)

Definition at line 18 of file syncrep.h.

{
    /* Copies of relevant fields from WalSnd shared-memory struct */
    pid_t       pid;
    XLogRecPtr  write;
    XLogRecPtr  flush;
    XLogRecPtr  apply;
    int         sync_standby_priority;
    /* Index of this walsender in the WalSnd shared-memory array */
    int         walsnd_index;
    /* This flag indicates whether this struct is about our own process */
    bool        is_me;
} SyncRepStandbyData;
 
/*
 * Struct for the configuration of synchronous replication.
 *
 * Note: this must be a flat representation that can be held in a single
 * chunk of malloc'd memory, so that it can be stored as the "extra" data
 * for the synchronous_standby_names GUC.
 */
typedef struct SyncRepConfigData
{
    int         config_size;    /* total size of this struct, in bytes */
    int         num_sync;       /* number of sync standbys that we need to
                                 * wait for */
    uint8       syncrep_method; /* method to choose sync standbys */
    int         nmembers;       /* number of members in the following list */
    /* member_names contains nmembers consecutive nul-terminated C strings */
    char        member_names[FLEXIBLE_ARRAY_MEMBER];
} SyncRepConfigData;
 
extern PGDLLIMPORT SyncRepConfigData *SyncRepConfig;
 
/* user-settable parameters for synchronous replication */
extern PGDLLIMPORT char *SyncRepStandbyNames;
 
/* called by user backend */
extern void SyncRepWaitForLSN(XLogRecPtr lsn, bool commit);
 
/* called at backend exit */
extern void SyncRepCleanupAtProcExit(void);
 
/* called by wal sender */
extern void SyncRepInitConfig(void);
extern void SyncRepReleaseWaiters(void);
 
/* called by wal sender and user backend */
extern int  SyncRepGetCandidateStandbys(SyncRepStandbyData **standbys);
 
/* called by checkpointer */
extern void SyncRepUpdateSyncStandbysDefined(void);
 
/*
 * Internal functions for parsing synchronous_standby_names grammar,
 * in syncrep_gram.y and syncrep_scanner.l
 */
union YYSTYPE;
typedef void *yyscan_t;
extern int  syncrep_yyparse(SyncRepConfigData **syncrep_parse_result_p, char **syncrep_parse_error_msg_p, yyscan_t yyscanner);
extern int  syncrep_yylex(union YYSTYPE *yylval_param, char **syncrep_parse_error_msg_p, yyscan_t yyscanner);
extern void syncrep_yyerror(SyncRepConfigData **syncrep_parse_result_p, char **syncrep_parse_error_msg_p, yyscan_t yyscanner, const char *str);
extern void syncrep_scanner_init(const char *str, yyscan_t *yyscannerp);
extern void syncrep_scanner_finish(yyscan_t yyscanner);
 
#endif                          /* _SYNCREP_H */

Typedef Documentation

SyncRepConfigData

typedef struct SyncRepConfigData SyncRepConfigData

SyncRepStandbyData

typedef struct SyncRepStandbyData SyncRepStandbyData

yyscan_t

typedef void* yyscan_t

Definition at line 100 of file syncrep.h.

Function Documentation

syncrep_scanner_finish()

void syncrep_scanner_finish ( yyscan_t  yyscanner )

extern

Definition at line 189 of file syncrep_scanner.l.

{
    pfree(yyextra);
    yylex_destroy(yyscanner);
}

References fb(), pfree(), and yyextra.

Referenced by check_synchronous_standby_names().

syncrep_scanner_init()

void syncrep_scanner_init ( const char *  str, yyscan_t *  yyscannerp  )

extern

Definition at line 173 of file syncrep_scanner.l.

{
    yyscan_t    yyscanner;
    struct syncrep_yy_extra_type *yyext = palloc0_object(struct syncrep_yy_extra_type);
 
    if (yylex_init(yyscannerp) != 0)
        elog(ERROR, "yylex_init() failed: %m");
 
    yyscanner = *yyscannerp;
 
    yyset_extra(yyext, yyscanner);
 
    yy_scan_string(str, yyscanner);
}

References elog, ERROR, fb(), palloc0_object, and str.

Referenced by check_synchronous_standby_names().

syncrep_yyerror()

void syncrep_yyerror ( SyncRepConfigData **  syncrep_parse_result_p, char **  syncrep_parse_error_msg_p, yyscan_t  yyscanner, const char *  str  )

extern

Definition at line 156 of file syncrep_scanner.l.

{
    struct yyguts_t *yyg = (struct yyguts_t *) yyscanner;   /* needed for yytext
                                                             * macro */
 
    /* report only the first error in a parse operation */
    if (*syncrep_parse_error_msg_p)
        return;
    if (yytext[0])
        *syncrep_parse_error_msg_p = psprintf("%s at or near \"%s\"",
                                              message, yytext);
    else
        *syncrep_parse_error_msg_p = psprintf("%s at end of input",
                                              message);
}

References fb(), and psprintf().

syncrep_yylex()

int syncrep_yylex ( union YYSTYPE *  yylval_param, char **  syncrep_parse_error_msg_p, yyscan_t  yyscanner  )

extern

syncrep_yyparse()

int syncrep_yyparse ( SyncRepConfigData **  syncrep_parse_result_p, char **  syncrep_parse_error_msg_p, yyscan_t  yyscanner  )

extern

Referenced by check_synchronous_standby_names().

SyncRepCleanupAtProcExit()

void SyncRepCleanupAtProcExit ( void  )

extern

Definition at line 416 of file syncrep.c.

{
    /*
     * First check if we are removed from the queue without the lock to not
     * slow down backend exit.
     */
    if (!dlist_node_is_detached(&MyProc->syncRepLinks))
    {
        LWLockAcquire(SyncRepLock, LW_EXCLUSIVE);
 
        /* maybe we have just been removed, so recheck */
        if (!dlist_node_is_detached(&MyProc->syncRepLinks))
            dlist_delete_thoroughly(&MyProc->syncRepLinks);
 
        LWLockRelease(SyncRepLock);
    }
}

References dlist_delete_thoroughly(), dlist_node_is_detached(), fb(), LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MyProc, and PGPROC::syncRepLinks.

Referenced by ProcKill().

SyncRepGetCandidateStandbys()

int SyncRepGetCandidateStandbys ( SyncRepStandbyData **  standbys )

extern

Definition at line 754 of file syncrep.c.

{
    int         i;
    int         n;
 
    /* Create result array */
    *standbys = palloc_array(SyncRepStandbyData, max_wal_senders);
 
    /* Quick exit if sync replication is not requested */
    if (SyncRepConfig == NULL)
        return 0;
 
    /* Collect raw data from shared memory */
    n = 0;
    for (i = 0; i < max_wal_senders; i++)
    {
        volatile WalSnd *walsnd;    /* Use volatile pointer to prevent code
                                     * rearrangement */
        SyncRepStandbyData *stby;
        WalSndState state;      /* not included in SyncRepStandbyData */
 
        walsnd = &WalSndCtl->walsnds[i];
        stby = *standbys + n;
 
        SpinLockAcquire(&walsnd->mutex);
        stby->pid = walsnd->pid;
        state = walsnd->state;
        stby->write = walsnd->write;
        stby->flush = walsnd->flush;
        stby->apply = walsnd->apply;
        stby->sync_standby_priority = walsnd->sync_standby_priority;
        SpinLockRelease(&walsnd->mutex);
 
        /* Must be active */
        if (stby->pid == 0)
            continue;
 
        /* Must be streaming or stopping */
        if (state != WALSNDSTATE_STREAMING &&
            state != WALSNDSTATE_STOPPING)
            continue;
 
        /* Must be synchronous */
        if (stby->sync_standby_priority == 0)
            continue;
 
        /* Must have a valid flush position */
        if (!XLogRecPtrIsValid(stby->flush))
            continue;
 
        /* OK, it's a candidate */
        stby->walsnd_index = i;
        stby->is_me = (walsnd == MyWalSnd);
        n++;
    }
 
    /*
     * In quorum mode, we return all the candidates.  In priority mode, if we
     * have too many candidates then return only the num_sync ones of highest
     * priority.
     */
    if (SyncRepConfig->syncrep_method == SYNC_REP_PRIORITY &&
        n > SyncRepConfig->num_sync)
    {
        /* Sort by priority ... */
        qsort(*standbys, n, sizeof(SyncRepStandbyData),
              standby_priority_comparator);
        /* ... then report just the first num_sync ones */
        n = SyncRepConfig->num_sync;
    }
 
    return n;
}

References fb(), i, max_wal_senders, MyWalSnd, SyncRepConfigData::num_sync, palloc_array, qsort, SpinLockAcquire, SpinLockRelease, standby_priority_comparator(), SYNC_REP_PRIORITY, SyncRepConfigData::syncrep_method, SyncRepConfig, WalSndCtl, WalSndCtlData::walsnds, WALSNDSTATE_STOPPING, WALSNDSTATE_STREAMING, and XLogRecPtrIsValid.

Referenced by pg_stat_get_wal_senders(), and SyncRepGetSyncRecPtr().

SyncRepInitConfig()

void SyncRepInitConfig ( void  )

extern

Definition at line 445 of file syncrep.c.

{
    int         priority;
 
    /*
     * Determine if we are a potential sync standby and remember the result
     * for handling replies from standby.
     */
    priority = SyncRepGetStandbyPriority();
    if (MyWalSnd->sync_standby_priority != priority)
    {
        SpinLockAcquire(&MyWalSnd->mutex);
        MyWalSnd->sync_standby_priority = priority;
        SpinLockRelease(&MyWalSnd->mutex);
 
        ereport(DEBUG1,
                (errmsg_internal("standby \"%s\" now has synchronous standby priority %d",
                                 application_name, priority)));
    }
}

References application_name, DEBUG1, ereport, errmsg_internal(), fb(), WalSnd::mutex, MyWalSnd, SpinLockAcquire, SpinLockRelease, WalSnd::sync_standby_priority, and SyncRepGetStandbyPriority().

Referenced by ProcessPendingWrites(), StartLogicalReplication(), StartReplication(), WalSndLoop(), and WalSndWaitForWal().

SyncRepReleaseWaiters()

void SyncRepReleaseWaiters ( void  )

extern

Definition at line 474 of file syncrep.c.

{
    volatile WalSndCtlData *walsndctl = WalSndCtl;
    XLogRecPtr  writePtr;
    XLogRecPtr  flushPtr;
    XLogRecPtr  applyPtr;
    bool        got_recptr;
    bool        am_sync;
    int         numwrite = 0;
    int         numflush = 0;
    int         numapply = 0;
 
    /*
     * If this WALSender is serving a standby that is not on the list of
     * potential sync standbys then we have nothing to do. If we are still
     * starting up, still running base backup or the current flush position is
     * still invalid, then leave quickly also.  Streaming or stopping WAL
     * senders are allowed to release waiters.
     */
    if (MyWalSnd->sync_standby_priority == 0 ||
        (MyWalSnd->state != WALSNDSTATE_STREAMING &&
         MyWalSnd->state != WALSNDSTATE_STOPPING) ||
        !XLogRecPtrIsValid(MyWalSnd->flush))
    {
        announce_next_takeover = true;
        return;
    }
 
    /*
     * We're a potential sync standby. Release waiters if there are enough
     * sync standbys and we are considered as sync.
     */
    LWLockAcquire(SyncRepLock, LW_EXCLUSIVE);
 
    /*
     * Check whether we are a sync standby or not, and calculate the synced
     * positions among all sync standbys.  (Note: although this step does not
     * of itself require holding SyncRepLock, it seems like a good idea to do
     * it after acquiring the lock.  This ensures that the WAL pointers we use
     * to release waiters are newer than any previous execution of this
     * routine used.)
     */
    got_recptr = SyncRepGetSyncRecPtr(&writePtr, &flushPtr, &applyPtr, &am_sync);
 
    /*
     * If we are managing a sync standby, though we weren't prior to this,
     * then announce we are now a sync standby.
     */
    if (announce_next_takeover && am_sync)
    {
        announce_next_takeover = false;
 
        if (SyncRepConfig->syncrep_method == SYNC_REP_PRIORITY)
            ereport(LOG,
                    (errmsg("standby \"%s\" is now a synchronous standby with priority %d",
                            application_name, MyWalSnd->sync_standby_priority)));
        else
            ereport(LOG,
                    (errmsg("standby \"%s\" is now a candidate for quorum synchronous standby",
                            application_name)));
    }
 
    /*
     * If the number of sync standbys is less than requested or we aren't
     * managing a sync standby then just leave.
     */
    if (!got_recptr || !am_sync)
    {
        LWLockRelease(SyncRepLock);
        announce_next_takeover = !am_sync;
        return;
    }
 
    /*
     * Set the lsn first so that when we wake backends they will release up to
     * this location.
     */
    if (walsndctl->lsn[SYNC_REP_WAIT_WRITE] < writePtr)
    {
        walsndctl->lsn[SYNC_REP_WAIT_WRITE] = writePtr;
        numwrite = SyncRepWakeQueue(false, SYNC_REP_WAIT_WRITE);
    }
    if (walsndctl->lsn[SYNC_REP_WAIT_FLUSH] < flushPtr)
    {
        walsndctl->lsn[SYNC_REP_WAIT_FLUSH] = flushPtr;
        numflush = SyncRepWakeQueue(false, SYNC_REP_WAIT_FLUSH);
    }
    if (walsndctl->lsn[SYNC_REP_WAIT_APPLY] < applyPtr)
    {
        walsndctl->lsn[SYNC_REP_WAIT_APPLY] = applyPtr;
        numapply = SyncRepWakeQueue(false, SYNC_REP_WAIT_APPLY);
    }
 
    LWLockRelease(SyncRepLock);
 
    elog(DEBUG3, "released %d procs up to write %X/%08X, %d procs up to flush %X/%08X, %d procs up to apply %X/%08X",
         numwrite, LSN_FORMAT_ARGS(writePtr),
         numflush, LSN_FORMAT_ARGS(flushPtr),
         numapply, LSN_FORMAT_ARGS(applyPtr));
}

References announce_next_takeover, application_name, DEBUG3, elog, ereport, errmsg(), fb(), WalSnd::flush, LOG, LSN_FORMAT_ARGS, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MyWalSnd, WalSnd::state, SYNC_REP_PRIORITY, SYNC_REP_WAIT_APPLY, SYNC_REP_WAIT_FLUSH, SYNC_REP_WAIT_WRITE, WalSnd::sync_standby_priority, SyncRepConfigData::syncrep_method, SyncRepConfig, SyncRepGetSyncRecPtr(), SyncRepWakeQueue(), WalSndCtl, WALSNDSTATE_STOPPING, WALSNDSTATE_STREAMING, and XLogRecPtrIsValid.

Referenced by ProcessStandbyReplyMessage().

SyncRepUpdateSyncStandbysDefined()

void SyncRepUpdateSyncStandbysDefined ( void  )

extern

Definition at line 963 of file syncrep.c.

{
    bool        sync_standbys_defined = SyncStandbysDefined();
 
    if (sync_standbys_defined !=
        ((WalSndCtl->sync_standbys_status & SYNC_STANDBY_DEFINED) != 0))
    {
        LWLockAcquire(SyncRepLock, LW_EXCLUSIVE);
 
        /*
         * If synchronous_standby_names has been reset to empty, it's futile
         * for backends to continue waiting.  Since the user no longer wants
         * synchronous replication, we'd better wake them up.
         */
        if (!sync_standbys_defined)
        {
            int         i;
 
            for (i = 0; i < NUM_SYNC_REP_WAIT_MODE; i++)
                SyncRepWakeQueue(true, i);
        }
 
        /*
         * Only allow people to join the queue when there are synchronous
         * standbys defined.  Without this interlock, there's a race
         * condition: we might wake up all the current waiters; then, some
         * backend that hasn't yet reloaded its config might go to sleep on
         * the queue (and never wake up).  This prevents that.
         */
        WalSndCtl->sync_standbys_status = SYNC_STANDBY_INIT |
            (sync_standbys_defined ? SYNC_STANDBY_DEFINED : 0);
 
        LWLockRelease(SyncRepLock);
    }
    else if ((WalSndCtl->sync_standbys_status & SYNC_STANDBY_INIT) == 0)
    {
        LWLockAcquire(SyncRepLock, LW_EXCLUSIVE);
 
        /*
         * Note that there is no need to wake up the queues here.  We would
         * reach this path only if SyncStandbysDefined() returns false, or it
         * would mean that some backends are waiting with the GUC set.  See
         * SyncRepWaitForLSN().
         */
        Assert(!SyncStandbysDefined());
 
        /*
         * Even if there is no sync standby defined, let the readers of this
         * information know that the sync standby data has been initialized.
         * This can just be done once, hence the previous check on
         * SYNC_STANDBY_INIT to avoid useless work.
         */
        WalSndCtl->sync_standbys_status |= SYNC_STANDBY_INIT;
 
        LWLockRelease(SyncRepLock);
    }
}

References Assert, fb(), i, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), NUM_SYNC_REP_WAIT_MODE, SYNC_STANDBY_DEFINED, SYNC_STANDBY_INIT, WalSndCtlData::sync_standbys_status, SyncRepWakeQueue(), SyncStandbysDefined, and WalSndCtl.

Referenced by UpdateSharedMemoryConfig().

SyncRepWaitForLSN()

void SyncRepWaitForLSN ( XLogRecPtr  lsn, bool  commit  )

extern

Definition at line 148 of file syncrep.c.

{
    int         mode;
 
    /*
     * This should be called while holding interrupts during a transaction
     * commit to prevent the follow-up shared memory queue cleanups to be
     * influenced by external interruptions.
     */
    Assert(InterruptHoldoffCount > 0);
 
    /*
     * Fast exit if user has not requested sync replication, or there are no
     * sync replication standby names defined.
     *
     * Since this routine gets called every commit time, it's important to
     * exit quickly if sync replication is not requested.
     *
     * We check WalSndCtl->sync_standbys_status flag without the lock and exit
     * immediately if SYNC_STANDBY_INIT is set (the checkpointer has
     * initialized this data) but SYNC_STANDBY_DEFINED is missing (no sync
     * replication requested).
     *
     * If SYNC_STANDBY_DEFINED is set, we need to check the status again later
     * while holding the lock, to check the flag and operate the sync rep
     * queue atomically.  This is necessary to avoid the race condition
     * described in SyncRepUpdateSyncStandbysDefined().  On the other hand, if
     * SYNC_STANDBY_DEFINED is not set, the lock is not necessary because we
     * don't touch the queue.
     */
    if (!SyncRepRequested() ||
        ((((volatile WalSndCtlData *) WalSndCtl)->sync_standbys_status) &
         (SYNC_STANDBY_INIT | SYNC_STANDBY_DEFINED)) == SYNC_STANDBY_INIT)
        return;
 
    /* Cap the level for anything other than commit to remote flush only. */
    if (commit)
        mode = SyncRepWaitMode;
    else
        mode = Min(SyncRepWaitMode, SYNC_REP_WAIT_FLUSH);
 
    Assert(dlist_node_is_detached(&MyProc->syncRepLinks));
    Assert(WalSndCtl != NULL);
 
    LWLockAcquire(SyncRepLock, LW_EXCLUSIVE);
    Assert(MyProc->syncRepState == SYNC_REP_NOT_WAITING);
 
    /*
     * We don't wait for sync rep if SYNC_STANDBY_DEFINED is not set.  See
     * SyncRepUpdateSyncStandbysDefined().
     *
     * Also check that the standby hasn't already replied. Unlikely race
     * condition but we'll be fetching that cache line anyway so it's likely
     * to be a low cost check.
     *
     * If the sync standby data has not been initialized yet
     * (SYNC_STANDBY_INIT is not set), fall back to a check based on the LSN,
     * then do a direct GUC check.
     */
    if (WalSndCtl->sync_standbys_status & SYNC_STANDBY_INIT)
    {
        if ((WalSndCtl->sync_standbys_status & SYNC_STANDBY_DEFINED) == 0 ||
            lsn <= WalSndCtl->lsn[mode])
        {
            LWLockRelease(SyncRepLock);
            return;
        }
    }
    else if (lsn <= WalSndCtl->lsn[mode])
    {
        /*
         * The LSN is older than what we need to wait for.  The sync standby
         * data has not been initialized yet, but we are OK to not wait
         * because we know that there is no point in doing so based on the
         * LSN.
         */
        LWLockRelease(SyncRepLock);
        return;
    }
    else if (!SyncStandbysDefined())
    {
        /*
         * If we are here, the sync standby data has not been initialized yet,
         * and the LSN is newer than what need to wait for, so we have fallen
         * back to the best thing we could do in this case: a check on
         * SyncStandbysDefined() to see if the GUC is set or not.
         *
         * When the GUC has a value, we wait until the checkpointer updates
         * the status data because we cannot be sure yet if we should wait or
         * not. Here, the GUC has *no* value, we are sure that there is no
         * point to wait; this matters for example when initializing a
         * cluster, where we should never wait, and no sync standbys is the
         * default behavior.
         */
        LWLockRelease(SyncRepLock);
        return;
    }
 
    /*
     * Set our waitLSN so WALSender will know when to wake us, and add
     * ourselves to the queue.
     */
    MyProc->waitLSN = lsn;
    MyProc->syncRepState = SYNC_REP_WAITING;
    SyncRepQueueInsert(mode);
    Assert(SyncRepQueueIsOrderedByLSN(mode));
    LWLockRelease(SyncRepLock);
 
    /* Alter ps display to show waiting for sync rep. */
    if (update_process_title)
    {
        char        buffer[32];
 
        sprintf(buffer, "waiting for %X/%08X", LSN_FORMAT_ARGS(lsn));
        set_ps_display_suffix(buffer);
    }
 
    /*
     * Wait for specified LSN to be confirmed.
     *
     * Each proc has its own wait latch, so we perform a normal latch
     * check/wait loop here.
     */
    for (;;)
    {
        int         rc;
 
        /* Must reset the latch before testing state. */
        ResetLatch(MyLatch);
 
        /*
         * Acquiring the lock is not needed, the latch ensures proper
         * barriers. If it looks like we're done, we must really be done,
         * because once walsender changes the state to SYNC_REP_WAIT_COMPLETE,
         * it will never update it again, so we can't be seeing a stale value
         * in that case.
         */
        if (MyProc->syncRepState == SYNC_REP_WAIT_COMPLETE)
            break;
 
        /*
         * If a wait for synchronous replication is pending, we can neither
         * acknowledge the commit nor raise ERROR or FATAL.  The latter would
         * lead the client to believe that the transaction aborted, which is
         * not true: it's already committed locally. The former is no good
         * either: the client has requested synchronous replication, and is
         * entitled to assume that an acknowledged commit is also replicated,
         * which might not be true. So in this case we issue a WARNING (which
         * some clients may be able to interpret) and shut off further output.
         * We do NOT reset ProcDiePending, so that the process will die after
         * the commit is cleaned up.
         */
        if (ProcDiePending)
        {
            ereport(WARNING,
                    (errcode(ERRCODE_ADMIN_SHUTDOWN),
                     errmsg("canceling the wait for synchronous replication and terminating connection due to administrator command"),
                     errdetail("The transaction has already committed locally, but might not have been replicated to the standby.")));
            whereToSendOutput = DestNone;
            SyncRepCancelWait();
            break;
        }
 
        /*
         * It's unclear what to do if a query cancel interrupt arrives.  We
         * can't actually abort at this point, but ignoring the interrupt
         * altogether is not helpful, so we just terminate the wait with a
         * suitable warning.
         */
        if (QueryCancelPending)
        {
            QueryCancelPending = false;
            ereport(WARNING,
                    (errmsg("canceling wait for synchronous replication due to user request"),
                     errdetail("The transaction has already committed locally, but might not have been replicated to the standby.")));
            SyncRepCancelWait();
            break;
        }
 
        /*
         * Wait on latch.  Any condition that should wake us up will set the
         * latch, so no need for timeout.
         */
        rc = WaitLatch(MyLatch, WL_LATCH_SET | WL_POSTMASTER_DEATH, -1,
                       WAIT_EVENT_SYNC_REP);
 
        /*
         * If the postmaster dies, we'll probably never get an acknowledgment,
         * because all the wal sender processes will exit. So just bail out.
         */
        if (rc & WL_POSTMASTER_DEATH)
        {
            ProcDiePending = true;
            whereToSendOutput = DestNone;
            SyncRepCancelWait();
            break;
        }
    }
 
    /*
     * WalSender has checked our LSN and has removed us from queue. Clean up
     * state and leave.  It's OK to reset these shared memory fields without
     * holding SyncRepLock, because any walsenders will ignore us anyway when
     * we're not on the queue.  We need a read barrier to make sure we see the
     * changes to the queue link (this might be unnecessary without
     * assertions, but better safe than sorry).
     */
    pg_read_barrier();
    Assert(dlist_node_is_detached(&MyProc->syncRepLinks));
    MyProc->syncRepState = SYNC_REP_NOT_WAITING;
    MyProc->waitLSN = InvalidXLogRecPtr;
 
    /* reset ps display to remove the suffix */
    if (update_process_title)
        set_ps_display_remove_suffix();
}

References Assert, DestNone, dlist_node_is_detached(), ereport, errcode(), errdetail(), errmsg(), fb(), InterruptHoldoffCount, InvalidXLogRecPtr, LSN_FORMAT_ARGS, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), Min, mode, MyLatch, MyProc, pg_read_barrier, ProcDiePending, QueryCancelPending, ResetLatch(), set_ps_display_remove_suffix(), set_ps_display_suffix(), sprintf, SYNC_REP_NOT_WAITING, SYNC_REP_WAIT_COMPLETE, SYNC_REP_WAIT_FLUSH, SYNC_REP_WAITING, SYNC_STANDBY_DEFINED, SYNC_STANDBY_INIT, WalSndCtlData::sync_standbys_status, SyncRepCancelWait(), PGPROC::syncRepLinks, SyncRepQueueInsert(), SyncRepRequested, PGPROC::syncRepState, SyncRepWaitMode, SyncStandbysDefined, update_process_title, WaitLatch(), PGPROC::waitLSN, WalSndCtl, WARNING, whereToSendOutput, WL_LATCH_SET, and WL_POSTMASTER_DEATH.

Referenced by EndPrepare(), RecordTransactionAbortPrepared(), RecordTransactionCommit(), and RecordTransactionCommitPrepared().

Variable Documentation

SyncRepConfig

PGDLLIMPORT SyncRepConfigData* SyncRepConfig

extern

Definition at line 97 of file syncrep.c.

Referenced by assign_synchronous_standby_names(), pg_stat_get_wal_senders(), SyncRepGetCandidateStandbys(), SyncRepGetStandbyPriority(), SyncRepGetSyncRecPtr(), and SyncRepReleaseWaiters().

SyncRepStandbyNames

PGDLLIMPORT char* SyncRepStandbyNames

extern

Definition at line 90 of file syncrep.c.