#include "postgres.h"
#include "access/table.h"
#include "access/xlog_internal.h"
#include "access/xlogutils.h"
#include "access/xlogwait.h"
#include "commands/repack.h"
#include "commands/repack_internal.h"
#include "libpq/pqmq.h"
#include "replication/snapbuild.h"
#include "storage/ipc.h"
#include "storage/proc.h"
#include "tcop/tcopprot.h"
#include "utils/memutils.h"

Include dependency graph for repack_worker.c:

Macros
#define	REPL_PLUGIN_NAME "pgrepack"

Functions
static void	RepackWorkerShutdown (int code, Datum arg)

static LogicalDecodingContext *	repack_setup_logical_decoding (Oid relid)

static void	repack_cleanup_logical_decoding (LogicalDecodingContext *ctx)

static void	export_initial_snapshot (Snapshot snapshot, DecodingWorkerShared *shared)

static bool	decode_concurrent_changes (LogicalDecodingContext ctx, DecodingWorkerShared shared)

void	RepackWorkerMain (Datum main_arg)

bool	AmRepackWorker (void)

bool	change_useless_for_repack (XLogRecordBuffer *buf)

Variables
static bool	am_repack_worker = false

static XLogSegNo	repack_current_segment = 0

static RelFileLocator	repacked_rel_locator = {.relNumber = InvalidOid}

static RelFileLocator	repacked_rel_toast_locator = {.relNumber = InvalidOid}

Macro Definition Documentation

◆ REPL_PLUGIN_NAME

#define REPL_PLUGIN_NAME "pgrepack"

Definition at line 31 of file repack_worker.c.

Function Documentation

◆ AmRepackWorker()

bool AmRepackWorker ( void )

Definition at line 183 of file repack_worker.c.

{
    return am_repack_worker;
}

References am_repack_worker.

Referenced by mq_putmessage().

◆ change_useless_for_repack()

bool change_useless_for_repack ( XLogRecordBuffer * buf )

Definition at line 497 of file repack_worker.c.

{
    XLogReaderState *r = buf->record;
    RelFileLocator locator;
 
    /* TOAST locator should not be set unless the main is. */
    Assert(!OidIsValid(repacked_rel_toast_locator.relNumber) ||
           OidIsValid(repacked_rel_locator.relNumber));
 
    /*
     * Backends not involved in REPACK (CONCURRENTLY) should not do the
     * filtering.
     */
    if (!OidIsValid(repacked_rel_locator.relNumber))
        return false;
 
    /*
     * If the record does not contain the block 0, it's probably not INSERT /
     * UPDATE / DELETE. In any case, we do not have enough information to
     * filter the change out.
     */
    if (!XLogRecGetBlockTagExtended(r, 0, &locator, NULL, NULL, NULL))
        return false;
 
    /*
     * Decode the change if it belongs to the table we are repacking, or if it
     * belongs to its TOAST relation.
     */
    if (RelFileLocatorEquals(locator, repacked_rel_locator))
        return false;
    if (OidIsValid(repacked_rel_toast_locator.relNumber) &&
        RelFileLocatorEquals(locator, repacked_rel_toast_locator))
        return false;
 
    /* Filter out changes of other tables. */
    return true;
}

References Assert, buf, fb(), OidIsValid, XLogReaderState::record, RelFileLocatorEquals, RelFileLocator::relNumber, repacked_rel_locator, repacked_rel_toast_locator, and XLogRecGetBlockTagExtended().

Referenced by heap2_decode(), and heap_decode().

◆ decode_concurrent_changes()

static bool decode_concurrent_changes	(	LogicalDecodingContext *	ctx,
		DecodingWorkerShared *	shared
	)

static

Definition at line 361 of file repack_worker.c.

{
    RepackDecodingState *dstate;
    XLogRecPtr  lsn_upto;
    bool        done;
    char        fname[MAXPGPATH];
 
    dstate = (RepackDecodingState *) ctx->output_writer_private;
 
    /* Open the output file. */
    DecodingWorkerFileName(fname, shared->relid, shared->last_exported + 1);
    dstate->file = BufFileCreateFileSet(&shared->sfs.fs, fname);
 
    SpinLockAcquire(&shared->mutex);
    lsn_upto = shared->lsn_upto;
    done = shared->done;
    SpinLockRelease(&shared->mutex);
 
    while (true)
    {
        XLogRecord *record;
        XLogSegNo   segno_new;
        char       *errm = NULL;
        XLogRecPtr  end_lsn;
 
        CHECK_FOR_INTERRUPTS();
 
        record = XLogReadRecord(ctx->reader, &errm);
        if (record)
        {
            LogicalDecodingProcessRecord(ctx, ctx->reader);
 
            /*
             * If WAL segment boundary has been crossed, inform the decoding
             * system that the catalog_xmin can advance.
             */
            end_lsn = ctx->reader->EndRecPtr;
            XLByteToSeg(end_lsn, segno_new, wal_segment_size);
            if (segno_new != repack_current_segment)
            {
                LogicalConfirmReceivedLocation(end_lsn);
                elog(DEBUG1, "REPACK: confirmed receive location %X/%X",
                     (uint32) (end_lsn >> 32), (uint32) end_lsn);
                repack_current_segment = segno_new;
            }
        }
        else
        {
            ReadLocalXLogPageNoWaitPrivate *priv;
 
            if (errm)
                ereport(ERROR,
                        errmsg("%s", errm));
 
            /*
             * In the decoding loop we do not want to get blocked when there
             * is no more WAL available, otherwise the loop would become
             * uninterruptible.
             */
            priv = (ReadLocalXLogPageNoWaitPrivate *) ctx->reader->private_data;
            if (priv->end_of_wal)
                /* Do not miss the end of WAL condition next time. */
                priv->end_of_wal = false;
            else
                ereport(ERROR,
                        errmsg("could not read WAL record"));
        }
 
        /*
         * Whether we could read new record or not, keep checking if
         * 'lsn_upto' was specified.
         */
        if (!XLogRecPtrIsValid(lsn_upto))
        {
            SpinLockAcquire(&shared->mutex);
            lsn_upto = shared->lsn_upto;
            /* 'done' should be set at the same time as 'lsn_upto' */
            done = shared->done;
            SpinLockRelease(&shared->mutex);
        }
        if (XLogRecPtrIsValid(lsn_upto) &&
            ctx->reader->EndRecPtr >= lsn_upto)
            break;
 
        if (record == NULL)
        {
            int64       timeout = 0;
            WaitLSNResult res;
 
            /*
             * Before we retry reading, wait until new WAL is flushed.
             *
             * There is a race condition such that the backend executing
             * REPACK determines 'lsn_upto', but before it sets the shared
             * variable, we reach the end of WAL. In that case we'd need to
             * wait until the next WAL flush (unrelated to REPACK). Although
             * that should not be a problem in a busy system, it might be
             * noticeable in other cases, including regression tests (which
             * are not necessarily executed in parallel). Therefore it makes
             * sense to use timeout.
             *
             * If lsn_upto is valid, WAL records having LSN lower than that
             * should already have been flushed to disk.
             */
            if (!XLogRecPtrIsValid(lsn_upto))
                timeout = 100L;
            res = WaitForLSN(WAIT_LSN_TYPE_PRIMARY_FLUSH,
                             ctx->reader->EndRecPtr + 1,
                             timeout);
            if (res != WAIT_LSN_RESULT_SUCCESS &&
                res != WAIT_LSN_RESULT_TIMEOUT)
                ereport(ERROR,
                        errmsg("waiting for WAL failed"));
        }
    }
 
    /*
     * Close the file so we can make it available to the backend.
     */
    BufFileClose(dstate->file);
    dstate->file = NULL;
    SpinLockAcquire(&shared->mutex);
    shared->lsn_upto = InvalidXLogRecPtr;
    shared->last_exported++;
    SpinLockRelease(&shared->mutex);
    ConditionVariableSignal(&shared->cv);
 
    return done;
}

References BufFileClose(), BufFileCreateFileSet(), CHECK_FOR_INTERRUPTS, ConditionVariableSignal(), DecodingWorkerShared::cv, DEBUG1, DecodingWorkerFileName(), DecodingWorkerShared::done, elog, ReadLocalXLogPageNoWaitPrivate::end_of_wal, XLogReaderState::EndRecPtr, ereport, errmsg, ERROR, fb(), SharedFileSet::fs, InvalidXLogRecPtr, DecodingWorkerShared::last_exported, LogicalConfirmReceivedLocation(), LogicalDecodingProcessRecord(), DecodingWorkerShared::lsn_upto, MAXPGPATH, DecodingWorkerShared::mutex, LogicalDecodingContext::output_writer_private, XLogReaderState::private_data, LogicalDecodingContext::reader, DecodingWorkerShared::relid, repack_current_segment, DecodingWorkerShared::sfs, SpinLockAcquire(), SpinLockRelease(), WAIT_LSN_RESULT_SUCCESS, WAIT_LSN_RESULT_TIMEOUT, WAIT_LSN_TYPE_PRIMARY_FLUSH, WaitForLSN(), wal_segment_size, XLByteToSeg, XLogReadRecord(), and XLogRecPtrIsValid.

Referenced by RepackWorkerMain().

◆ export_initial_snapshot()

static void export_initial_snapshot	(	Snapshot	snapshot,
		DecodingWorkerShared *	shared
	)

static

Definition at line 329 of file repack_worker.c.

{
    char        fname[MAXPGPATH];
    BufFile    *file;
    Size        snap_size;
    char       *snap_space;
 
    snap_size = EstimateSnapshotSpace(snapshot);
    snap_space = (char *) palloc(snap_size);
    SerializeSnapshot(snapshot, snap_space);
 
    DecodingWorkerFileName(fname, shared->relid, shared->last_exported + 1);
    file = BufFileCreateFileSet(&shared->sfs.fs, fname);
    /* To make restoration easier, write the snapshot size first. */
    BufFileWrite(file, &snap_size, sizeof(snap_size));
    BufFileWrite(file, snap_space, snap_size);
    BufFileClose(file);
    pfree(snap_space);
 
    /* Increase the counter to tell the backend that the file is available. */
    SpinLockAcquire(&shared->mutex);
    shared->last_exported++;
    SpinLockRelease(&shared->mutex);
    ConditionVariableSignal(&shared->cv);
}

References BufFileClose(), BufFileCreateFileSet(), BufFileWrite(), ConditionVariableSignal(), DecodingWorkerShared::cv, DecodingWorkerFileName(), EstimateSnapshotSpace(), fb(), SharedFileSet::fs, DecodingWorkerShared::last_exported, MAXPGPATH, DecodingWorkerShared::mutex, palloc(), pfree(), DecodingWorkerShared::relid, SerializeSnapshot(), DecodingWorkerShared::sfs, SpinLockAcquire(), and SpinLockRelease().

Referenced by RepackWorkerMain().

◆ repack_cleanup_logical_decoding()

static void repack_cleanup_logical_decoding ( LogicalDecodingContext * ctx )

static

Definition at line 313 of file repack_worker.c.

{
    RepackDecodingState *dstate;
 
    dstate = (RepackDecodingState *) ctx->output_writer_private;
    if (dstate->slot)
        ExecDropSingleTupleTableSlot(dstate->slot);
 
    FreeDecodingContext(ctx);
    ReplicationSlotDropAcquired();
}

References ExecDropSingleTupleTableSlot(), fb(), FreeDecodingContext(), LogicalDecodingContext::output_writer_private, and ReplicationSlotDropAcquired().

Referenced by RepackWorkerMain().

◆ repack_setup_logical_decoding()

static LogicalDecodingContext * repack_setup_logical_decoding ( Oid relid )

static

Definition at line 196 of file repack_worker.c.

{
    Relation    rel;
    Oid         toastrelid;
    LogicalDecodingContext *ctx;
    NameData    slotname;
    RepackDecodingState *dstate;
    MemoryContext oldcxt;
 
    /*
     * REPACK CONCURRENTLY is not allowed in a transaction block, so this
     * should never fire.
     */
    Assert(!TransactionIdIsValid(GetTopTransactionIdIfAny()));
 
    /*
     * Make sure we can use logical decoding.
     */
    CheckSlotPermissions();
    CheckLogicalDecodingRequirements();
 
    /*
     * A single backend should not execute multiple REPACK commands at a time,
     * so use PID to make the slot unique.
     *
     * RS_TEMPORARY so that the slot gets cleaned up on ERROR.
     */
    snprintf(NameStr(slotname), NAMEDATALEN, "repack_%d", MyProcPid);
    ReplicationSlotCreate(NameStr(slotname), true, RS_TEMPORARY, false, false,
                          false);
 
    EnsureLogicalDecodingEnabled();
 
    /*
     * Neither prepare_write nor do_write callback nor update_progress is
     * useful for us.
     */
    ctx = CreateInitDecodingContext(REPL_PLUGIN_NAME,
                                    NIL,
                                    true,
                                    InvalidXLogRecPtr,
                                    XL_ROUTINE(.page_read = read_local_xlog_page,
                                               .segment_open = wal_segment_open,
                                               .segment_close = wal_segment_close),
                                    NULL, NULL, NULL);
 
    /*
     * We don't have control on setting fast_forward, so at least check it.
     */
    Assert(!ctx->fast_forward);
 
    /* Avoid logical decoding of other relations. */
    rel = table_open(relid, AccessShareLock);
    repacked_rel_locator = rel->rd_locator;
    toastrelid = rel->rd_rel->reltoastrelid;
    if (OidIsValid(toastrelid))
    {
        Relation    toastrel;
 
        /* Avoid logical decoding of other TOAST relations. */
        toastrel = table_open(toastrelid, AccessShareLock);
        repacked_rel_toast_locator = toastrel->rd_locator;
        table_close(toastrel, AccessShareLock);
    }
    table_close(rel, AccessShareLock);
 
    DecodingContextFindStartpoint(ctx);
 
    /*
     * decode_concurrent_changes() needs non-blocking callback.
     */
    ctx->reader->routine.page_read = read_local_xlog_page_no_wait;
 
    /* Some WAL records should have been read. */
    Assert(ctx->reader->EndRecPtr != InvalidXLogRecPtr);
 
    /*
     * Initialize repack_current_segment so that we can notice WAL segment
     * boundaries.
     */
    XLByteToSeg(ctx->reader->EndRecPtr, repack_current_segment,
                wal_segment_size);
 
    /* Our private state belongs to the decoding context. */
    oldcxt = MemoryContextSwitchTo(ctx->context);
 
    /*
     * read_local_xlog_page_no_wait() needs to be able to indicate the end of
     * WAL.
     */
    ctx->reader->private_data = palloc0_object(ReadLocalXLogPageNoWaitPrivate);
    dstate = palloc0_object(RepackDecodingState);
    MemoryContextSwitchTo(oldcxt);
 
#ifdef  USE_ASSERT_CHECKING
    dstate->relid = relid;
#endif
 
    dstate->change_cxt = AllocSetContextCreate(ctx->context,
                                               "REPACK - change",
                                               ALLOCSET_DEFAULT_SIZES);
 
    /* The file will be set as soon as we have it opened. */
    dstate->file = NULL;
 
    /*
     * Memory context and resource owner for long-lived resources.
     */
    dstate->worker_cxt = CurrentMemoryContext;
    dstate->worker_resowner = CurrentResourceOwner;
 
    ctx->output_writer_private = dstate;
 
    return ctx;
}

References AccessShareLock, ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, CheckLogicalDecodingRequirements(), CheckSlotPermissions(), LogicalDecodingContext::context, CreateInitDecodingContext(), CurrentMemoryContext, CurrentResourceOwner, DecodingContextFindStartpoint(), XLogReaderState::EndRecPtr, EnsureLogicalDecodingEnabled(), LogicalDecodingContext::fast_forward, fb(), GetTopTransactionIdIfAny(), InvalidXLogRecPtr, MemoryContextSwitchTo(), MyProcPid, NAMEDATALEN, NameStr, NIL, OidIsValid, LogicalDecodingContext::output_writer_private, XLogReaderRoutine::page_read, palloc0_object, XLogReaderState::private_data, RelationData::rd_locator, RelationData::rd_rel, read_local_xlog_page(), read_local_xlog_page_no_wait(), LogicalDecodingContext::reader, repack_current_segment, repacked_rel_locator, repacked_rel_toast_locator, REPL_PLUGIN_NAME, ReplicationSlotCreate(), XLogReaderState::routine, RS_TEMPORARY, snprintf, table_close(), table_open(), TransactionIdIsValid, wal_segment_close(), wal_segment_open(), wal_segment_size, XL_ROUTINE, and XLByteToSeg.

Referenced by RepackWorkerMain().

◆ RepackWorkerMain()

void RepackWorkerMain ( Datum main_arg )

Definition at line 57 of file repack_worker.c.

{
    dsm_segment *seg;
    DecodingWorkerShared *shared;
    shm_mq     *mq;
    shm_mq_handle *mqh;
    LogicalDecodingContext *decoding_ctx;
    SharedFileSet *sfs;
    Snapshot    snapshot;
 
    am_repack_worker = true;
 
    /*
     * Override the default bgworker_die() with die() so we can use
     * CHECK_FOR_INTERRUPTS().
     */
    pqsignal(SIGTERM, die);
    BackgroundWorkerUnblockSignals();
 
    seg = dsm_attach(DatumGetUInt32(main_arg));
    if (seg == NULL)
        ereport(ERROR,
                errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                errmsg("could not map dynamic shared memory segment"));
 
    shared = (DecodingWorkerShared *) dsm_segment_address(seg);
    shared->dsm_seg = seg;
 
    /* Arrange to signal the leader if we exit. */
    before_shmem_exit(RepackWorkerShutdown, PointerGetDatum(shared));
 
    /*
     * Join locking group - see the comments around the call of
     * start_repack_decoding_worker().
     */
    if (!BecomeLockGroupMember(shared->backend_proc, shared->backend_pid))
        return;                 /* The leader is not running anymore. */
 
    /*
     * Setup a queue to send error messages to the backend that launched this
     * worker.
     */
    mq = (shm_mq *) (char *) BUFFERALIGN(shared->error_queue);
    shm_mq_set_sender(mq, MyProc);
    mqh = shm_mq_attach(mq, seg, NULL);
    pq_redirect_to_shm_mq(seg, mqh);
    pq_set_parallel_leader(shared->backend_pid,
                           shared->backend_proc_number);
 
    /* Connect to the database. */
    BackgroundWorkerInitializeConnectionByOid(shared->dbid, shared->roleid, 0);
 
    /*
     * Transaction is needed to open relation, and it also provides us with a
     * resource owner.
     */
    StartTransactionCommand();
 
    shared = (DecodingWorkerShared *) dsm_segment_address(seg);
 
    /*
     * Not sure the spinlock is needed here - the backend should not change
     * anything in the shared memory until we have serialized the snapshot.
     */
    SpinLockAcquire(&shared->mutex);
    Assert(!XLogRecPtrIsValid(shared->lsn_upto));
    sfs = &shared->sfs;
    SpinLockRelease(&shared->mutex);
 
    SharedFileSetAttach(sfs, seg);
 
    /*
     * Prepare to capture the concurrent data changes ourselves.
     */
    decoding_ctx = repack_setup_logical_decoding(shared->relid);
 
    /* Announce that we're ready. */
    SpinLockAcquire(&shared->mutex);
    shared->initialized = true;
    SpinLockRelease(&shared->mutex);
    ConditionVariableSignal(&shared->cv);
 
    /* There doesn't seem to a nice API to set these */
    XactIsoLevel = XACT_REPEATABLE_READ;
    XactReadOnly = true;
 
    /* Build the initial snapshot and export it. */
    snapshot = SnapBuildInitialSnapshot(decoding_ctx->snapshot_builder);
    export_initial_snapshot(snapshot, shared);
 
    /*
     * Only historic snapshots should be used now. Do not let us restrict the
     * progress of xmin horizon.
     */
    InvalidateCatalogSnapshot();
 
    for (;;)
    {
        bool        stop = decode_concurrent_changes(decoding_ctx, shared);
 
        if (stop)
            break;
 
    }
 
    /* Cleanup. */
    repack_cleanup_logical_decoding(decoding_ctx);
    CommitTransactionCommand();
}

◆ RepackWorkerShutdown()

static void RepackWorkerShutdown	(	int	code,
		Datum	arg
	)

static

Definition at line 171 of file repack_worker.c.

{
    DecodingWorkerShared *shared = (DecodingWorkerShared *) DatumGetPointer(arg);
 
    SendProcSignal(shared->backend_pid,
                   PROCSIG_REPACK_MESSAGE,
                   shared->backend_proc_number);
 
    dsm_detach(shared->dsm_seg);
}