public inbox for [email protected]help / color / mirror / Atom feed
[PATCH v5 1/3] Move callback-call from ReadPageInternal to XLogReadRecord. 32+ messages / 11 participants [nested] [flat]
* [PATCH v5 1/3] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) WAL reader facility used to call given page-reader callback function in the ReadPageInternal, which is two levels below from ReadRecord. That makes things a bit complex, but furthermore we are going to have additional callbacks for encryption, compression or something like that works before or after reading pages. Just adding them as new callback makes things messier. If the caller of the current ReadRecord could call page fetching function directly, things would get quite easier. As the first step of that change, this patch moves the place where that callbacks are called by 1 level above ReadPageInternal. XLogPageRead uses a loop over new function XLogNeedData and the callback directly instead of ReadPageInternal. --- src/backend/access/transam/xlog.c | 15 +- src/backend/access/transam/xlogreader.c | 355 ++++++++++++++++--------- src/backend/access/transam/xlogutils.c | 10 +- src/backend/replication/logical/logicalfuncs.c | 4 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 17 +- src/bin/pg_waldump/pg_waldump.c | 8 +- src/include/access/xlogreader.h | 30 ++- src/include/access/xlogutils.h | 2 +- src/include/replication/logicalfuncs.h | 2 +- 10 files changed, 292 insertions(+), 161 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index e651a841bb..acd4ed89c4 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -884,7 +884,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, int source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *readTLI); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, @@ -11521,7 +11521,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *readTLI) { @@ -11580,7 +11580,8 @@ retry: readLen = 0; readSource = 0; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11675,7 +11676,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11689,8 +11691,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index c6faf48d24..1d8d470158 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -36,8 +36,8 @@ static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); static bool ValidXLogRecord(XLogReaderState *state, XLogRecord *record, XLogRecPtr recptr); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool includes_page_header); static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static void ResetDecoder(XLogReaderState *state); @@ -100,7 +100,7 @@ XLogReaderAllocate(int wal_segment_size, XLogPageReadCB pagereadfunc, /* system_identifier initialized to zeroes above */ state->private_data = private_data; /* ReadRecPtr and EndRecPtr initialized to zeroes above */ - /* readSegNo, readOff, readLen, readPageTLI initialized to zeroes above */ + /* readSegNo, readLen, readPageTLI initialized to zeroes above */ state->errormsg_buf = palloc_extended(MAX_ERRORMSG_LEN + 1, MCXT_ALLOC_NO_OOM); if (!state->errormsg_buf) @@ -224,7 +224,6 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -276,15 +275,21 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, - targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have loaded at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -310,8 +315,8 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -388,14 +393,21 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(total_len - gotlen + SizeOfXLogShortPHD, + XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -424,20 +436,38 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); + if (state->readLen < pageHeaderSize) + { + while (XLogNeedData(state, targetPagePtr, pageHeaderSize, + false)) + { + if (!state->read_page(state, + state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + } - Assert(pageHeaderSize <= readOff); + Assert(pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); + if (state->readLen < pageHeaderSize + len) + { + if (XLogNeedData(state, targetPagePtr, pageHeaderSize + len, + true)) + { + if (!state->read_page(state, + state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + } memcpy(buffer, (char *) contdata, len); buffer += len; @@ -468,9 +498,16 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -504,7 +541,7 @@ err: * Invalidate the read state. We might read from a different source after * failure. */ - XLogReaderInvalReadState(state); + XLogReaderDiscardReadingPage(state); if (state->errormsg_buf[0] != '\0') *errormsg = state->errormsg_buf; @@ -513,120 +550,181 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. includes_page_header indicates that + * the requested region contains page header. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or error is + * found. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall fill the buffer at + * least with that portion of data and set state->readLen to the actual length + * of loaded data before the next call to this function. + * + * If reqLen does not contain page header, includes_page_header should be + * true. This function internally adds page header to reqLen. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool includes_page_header) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; - - Assert((pageptr % XLOG_BLCKSZ) == 0); - - XLByteToSeg(pageptr, targetSegNo, state->wal_segment_size); - targetPageOff = XLogSegmentOffset(pageptr, state->wal_segment_size); + uint32 addLen = 0; /* check whether we have all the requested data already */ - if (targetSegNo == state->readSegNo && targetPageOff == state->readOff && - reqLen <= state->readLen) - return state->readLen; + if (state->page_verified && pageptr == state->readPagePtr) + { + if (includes_page_header) + { + /* + * Include page header length in request, but the total shoudn't + * exceed the block size. + */ + uint32 headerLen = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + if (reqLen + headerLen <= XLOG_BLCKSZ) + addLen = headerLen; + else + addLen = XLOG_BLCKSZ - reqLen; + } + + if (reqLen + addLen <= state->readLen) + return false; + } + + /* Haven't loaded any data yet? Then request it. */ + if (XLogRecPtrIsInvalid(state->readPagePtr) || state->readLen < 0) + { + state->readPagePtr = pageptr; + state->readLen = Max(reqLen, SizeOfXLogShortPHD); + state->page_verified = false; + return true; + } + + if (!state->page_verified) + { + uint32 pageHeaderSize; + uint32 addLen = 0; + + /* just loaded new data so needs to verify page header */ + + /* The caller must have loaded at least page header */ + Assert(state->readLen >= SizeOfXLogShortPHD); + + /* + * We have enough data to check the header length. Recheck the loaded + * length if it is a long header if any. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + /* + * If we have not loaded a page so far, readLen is zero, which is + * shorter than pageHeaderSize here. + */ + if (state->readLen < pageHeaderSize) + { + state->readPagePtr = pageptr; + state->readLen = pageHeaderSize; + return true; + } + + /* + * Now that we know we have the full header, validate it. + */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* force reading the page again. */ + XLogReaderDiscardReadingPage(state); + + return false; + } + + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->readSegNo, + state->wal_segment_size); + + /* + * calculate additional length for page header so that the total length + * doesn't exceed the block size. + */ + if (includes_page_header) + { + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; + + Assert(addLen >= 0); + } + + /* Usually we have requested data loaded in buffer here. */ + if (pageptr == state->readPagePtr && reqLen + addLen <= state->readLen) + return false; + + /* + * In the case the page is requested for the first record in the page, + * the previous request have been made not counting page header + * length. Request again for the same page with the length known to be + * needed. Otherwise we don't know the header length of the new page. + */ + if (pageptr != state->readPagePtr) + addLen = 0; + } + + /* Data is not in our buffer, make a new load request to the caller. */ + XLByteToSeg(pageptr, targetSegNo, state->wal_segment_size); + targetPageOff = XLogSegmentOffset(pageptr, state->wal_segment_size); + Assert((pageptr % XLOG_BLCKSZ) == 0); + + /* + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. + */ + state->page_verified = false; /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * * Whenever switching to a new WAL segment, we read the first page of the * file and validate its header, even if that's not where the target * record is. This is so that we can check the additional identification * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. */ if (targetSegNo != state->readSegNo && targetPageOff != 0) { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; - - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf, &state->readPageTLI); - if (readLen < 0) - goto err; - - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); - - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + /* + * Then we'll see that the targetSegNo now matches the readSegNo, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * Request the caller to load the requested page. We need at least a short + * page header so that we can validate it. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf, &state->readPageTLI); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); - - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; - - Assert(readLen >= reqLen); - - hdr = (XLogPageHeader) state->readBuf; - - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf, &state->readPageTLI); - if (readLen < 0) - goto err; - } - - /* - * Now that we know we have the full header, validate it. - */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->readSegNo = targetSegNo; - state->readOff = targetPageOff; - state->readLen = readLen; - - return readLen; - -err: - XLogReaderInvalReadState(state); - return -1; + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* - * Invalidate the xlogreader's read state to force a re-read. + * Invalidate current reading page buffer */ void -XLogReaderInvalReadState(XLogReaderState *state) +XLogReaderDiscardReadingPage(XLogReaderState *state) { - state->readSegNo = 0; - state->readOff = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -904,7 +1002,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -912,7 +1009,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * CheckPage() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -921,8 +1018,15 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) targetPagePtr = tmpRecPtr - targetRecOff; /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; @@ -930,8 +1034,15 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) pageHeaderSize = XLogPageHeaderSize(header); /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) + while (XLogNeedData(state, targetPagePtr, pageHeaderSize, false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + + if (!state->page_verified) goto err; /* skip over potential continuation data */ @@ -989,7 +1100,7 @@ out: /* Reset state to what we had before finding the record */ state->ReadRecPtr = saved_state.ReadRecPtr; state->EndRecPtr = saved_state.EndRecPtr; - XLogReaderInvalReadState(state); + XLogReaderDiscardReadingPage(state); return found; } diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index 1fc39333f1..dad9074b9f 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -803,7 +803,7 @@ void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { const XLogRecPtr lastReadPage = state->readSegNo * - state->wal_segment_size + state->readOff; + state->wal_segment_size + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -907,7 +907,7 @@ XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wa * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI) @@ -1009,7 +1009,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -1026,5 +1027,6 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, XLOG_BLCKSZ); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index d974400d6e..7210a940bd 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -114,12 +114,12 @@ check_permissions(void) (errmsg("must be superuser or replication role to use replication slots")))); } -int +bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI) { return read_local_xlog_page(state, targetPagePtr, reqLen, - targetRecPtr, cur_page, pageTLI); + targetRecPtr, cur_page, pageTLI); } /* diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 23870a25a5..cc35e2a04d 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -761,7 +761,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI) { @@ -779,7 +779,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -789,7 +792,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* now actually read the data, we know it's there */ XLogRead(cur_page, targetPagePtr, XLOG_BLCKSZ); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index 63c3879ead..4df53964e4 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -47,7 +47,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *pageTLI); @@ -235,7 +235,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *pageTLI) @@ -290,7 +290,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -303,7 +304,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -316,13 +318,16 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); *pageTLI = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index b95d467805..96d1f36ebc 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -421,7 +421,7 @@ XLogDumpXLogRead(const char *directory, TimeLineID timeline_id, /* * XLogReader read_page callback */ -static int +static bool XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetPtr, char *readBuff, TimeLineID *curFileTLI) { @@ -437,14 +437,16 @@ XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } XLogDumpXLogRead(private->inpath, private->timeline, targetPagePtr, readBuff, count); - return count; + state->readLen = count; + return true; } /* diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index aa9bc63725..030f56802b 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -34,7 +34,7 @@ typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -123,6 +123,18 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ /* ---------------------------------------- * Decoded representation of current record @@ -149,17 +161,9 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - - /* last read segment, segment offset, TLI for data currently in readBuf */ + /* last read segment and segment offset for data currently in readBuf */ + bool page_verified; XLogSegNo readSegNo; - uint32 readOff; - TimeLineID readPageTLI; /* * beginning of prior page read, and its TLI. Doesn't necessarily @@ -216,8 +220,8 @@ extern struct XLogRecord *XLogReadRecord(XLogReaderState *state, extern bool XLogReaderValidatePageHeader(XLogReaderState *state, XLogRecPtr recptr, char *phdr); -/* Invalidate read state */ -extern void XLogReaderInvalReadState(XLogReaderState *state); +/* Discard bufferd page */ +extern void XLogReaderDiscardReadingPage(XLogReaderState *state); #ifdef FRONTEND extern XLogRecPtr XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr); diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 4105b59904..0842af9f95 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI); diff --git a/src/include/replication/logicalfuncs.h b/src/include/replication/logicalfuncs.h index a9c178a9e6..8e52b1f4aa 100644 --- a/src/include/replication/logicalfuncs.h +++ b/src/include/replication/logicalfuncs.h @@ -11,7 +11,7 @@ #include "replication/logical.h" -extern int logical_read_local_xlog_page(XLogReaderState *state, +extern bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI); -- 2.16.3 ----Next_Part(Fri_Sep_06_16_33_18_2019_198)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v5-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH v12 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) The current WAL record reader reads page data using a call back function. Although it is not so problematic alone, it would be a problem if we are going to do add tasks like encryption which is performed on page data before WAL reader reads them. To avoid that the record reader facility has to have a new code path corresponds to every new callback, this patch separates page reader from WAL record reading facility by modifying the current WAL record reader to a state machine. As the first step of that change, this patch moves the page reader function out of ReadPageInternal, then the remaining tasks of the function are taken over by the new function XLogNeedData. As the result XLogPageRead directly calls the page reader callback function according to the feedback from XLogNeedData. --- src/backend/access/transam/xlog.c | 16 +- src/backend/access/transam/xlogreader.c | 272 ++++++++++-------- src/backend/access/transam/xlogutils.c | 12 +- .../replication/logical/logicalfuncs.c | 2 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 16 +- src/bin/pg_waldump/pg_waldump.c | 8 +- src/include/access/xlogreader.h | 23 +- src/include/access/xlogutils.h | 2 +- src/include/replication/logicalfuncs.h | 2 +- 10 files changed, 213 insertions(+), 150 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 5f0ee50092..4a6bd6e002 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -884,7 +884,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, int source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr); @@ -4249,7 +4249,6 @@ ReadRecord(XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, XLogRecord *record; XLogPageReadPrivate *private = (XLogPageReadPrivate *) xlogreader->private_data; - /* Pass through parameters to XLogPageRead */ private->fetching_ckpt = fetching_ckpt; private->emode = emode; private->randAccess = (RecPtr != InvalidXLogRecPtr); @@ -11537,7 +11536,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -11596,7 +11595,8 @@ retry: readLen = 0; readSource = 0; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11691,7 +11691,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11705,8 +11706,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index 67418b05f1..063223701e 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -36,8 +36,8 @@ static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static bool allocate_recordbuf(XLogReaderState *state, uint32 reclength); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool header_inclusive); static void XLogReaderInvalReadState(XLogReaderState *state); static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); @@ -245,7 +245,6 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -297,14 +296,20 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + RecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -330,8 +335,8 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -404,18 +409,25 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) do { + int rest_len = total_len - gotlen; + /* Calculate pointer to beginning of next page */ targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(rest_len, XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -444,21 +456,14 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); - - Assert(pageHeaderSize <= readOff); + Assert(pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); - + Assert (pageHeaderSize + len <= state->readLen); memcpy(buffer, (char *) contdata, len); buffer += len; gotlen += len; @@ -488,9 +493,15 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -533,109 +544,139 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. header_inclusive indicates that + * reqLen is calculated including page header length. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or found + * error. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall call this function + * again after filling the buffer at least with that portion of data and set + * state->readLen to the length of actually loaded data. + * + * If header_inclusive is false, corrects reqLen internally by adding the + * actual page header length and may request caller for new data. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool header_inclusive) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; + uint32 addLen = 0; - Assert((pageptr % XLOG_BLCKSZ) == 0); + /* Some data is loaded, but page header is not verified yet. */ + if (!state->page_verified && + !XLogRecPtrIsInvalid(state->readPagePtr) && state->readLen >= 0) + { + uint32 pageHeaderSize; - XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); - targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + /* just loaded new data so needs to verify page header */ - /* check whether we have all the requested data already */ - if (targetSegNo == state->seg.ws_segno && - targetPageOff == state->segoff && reqLen <= state->readLen) - return state->readLen; + /* The caller must have loaded at least page header */ + Assert (state->readLen >= SizeOfXLogShortPHD); - /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * - * Whenever switching to a new WAL segment, we read the first page of the - * file and validate its header, even if that's not where the target - * record is. This is so that we can check the additional identification - * info that is present in the first page's "long" header. - */ - if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) - { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; + /* + * We have enough data to check the header length. Recheck the loaded + * length against the actual header length. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Request more data if we don't have the full header. */ + if (state->readLen < pageHeaderSize) + { + state->readLen = pageHeaderSize; + return true; + } + + /* Now that we know we have the full header, validate it. */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* That's bad. Force reading the page again. */ + XLogReaderInvalReadState(state); - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); + return false; + } - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->seg.ws_segno, + state->segcxt.ws_segsize); } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * The loaded page may not be the one caller is supposing to read when we + * are verifying the first page of new segment. In that case, skip further + * verification and immediately load the target page. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); + if (state->page_verified && pageptr == state->readPagePtr) + { - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; + /* + * calculate additional length for page header keeping the total + * length within the block size. + */ + if (!header_inclusive) + { + uint32 pageHeaderSize = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); - Assert(readLen >= reqLen); + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; - hdr = (XLogPageHeader) state->readBuf; + Assert(addLen >= 0); + } - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Return if we already have it. */ + if (reqLen + addLen <= state->readLen) + return false; } + /* Data is not in our buffer, request the caller for it. */ + XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); + targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + Assert((pageptr % XLOG_BLCKSZ) == 0); + /* - * Now that we know we have the full header, validate it. + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->seg.ws_segno = targetSegNo; - state->segoff = targetPageOff; - state->readLen = readLen; + state->page_verified = false; - return readLen; + /* + * Whenever switching to a new WAL segment, we read the first page of the + * file and validate its header, even if that's not where the target + * record is. This is so that we can check the additional identification + * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. + */ + if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) + { + /* + * Then we'll see that the targetSegNo now matches the ws_segno, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; + } -err: - XLogReaderInvalReadState(state); - return -1; + /* + * Request the caller to load the page. We need at least a short page + * header so that we can validate it. + */ + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* @@ -644,9 +685,7 @@ err: static void XLogReaderInvalReadState(XLogReaderState *state) { - state->seg.ws_segno = 0; - state->segoff = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -924,7 +963,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -932,7 +970,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * XLogNeedData() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -940,19 +978,23 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) /* scroll back to page boundary */ targetPagePtr = tmpRecPtr - targetRecOff; - /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; pageHeaderSize = XLogPageHeaderSize(header); - /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) - goto err; + /* we should have read the page header */ + Assert (state->readLen >= pageHeaderSize); /* skip over potential continuation data */ if (header->xlp_info & XLP_FIRST_IS_CONTRECORD) diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index 446760ed6e..060fbc0c4c 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -680,8 +680,8 @@ XLogTruncateRelation(RelFileNode rnode, ForkNumber forkNum, void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { - const XLogRecPtr lastReadPage = (state->seg.ws_segno * - state->segcxt.ws_segsize + state->segoff); + const XLogRecPtr lastReadPage = state->seg.ws_segno * + state->segcxt.ws_segsize + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -813,7 +813,7 @@ wal_segment_open(XLogSegNo nextSegNo, WALSegmentContext *segcxt, * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -915,7 +915,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -933,7 +934,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, WALReadRaiseError(&errinfo); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } /* diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index aa2106b152..4b0e8ea773 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -106,7 +106,7 @@ check_permissions(void) (errmsg("must be superuser or replication role to use replication slots")))); } -int +bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 8bafa65e50..554c186ae1 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -762,7 +762,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -782,7 +782,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -812,7 +815,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req XLByteToSeg(targetPagePtr, segno, sendCxt->ws_segsize); CheckXLogRemoved(segno, sendSeg->ws_tli); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index 1d03375a3e..795e84ff9f 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -44,7 +44,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); @@ -228,7 +228,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -283,7 +283,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -296,7 +297,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -309,13 +311,15 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); xlogreader->seg.ws_tli = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index 30a5851d87..df13cf3173 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -324,7 +324,7 @@ WALDumpOpenSegment(XLogSegNo nextSegNo, WALSegmentContext *segcxt, /* * XLogReader read_page callback */ -static int +static bool WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetPtr, char *readBuff) { @@ -341,7 +341,8 @@ WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } @@ -366,7 +367,8 @@ WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, (Size) errinfo.wre_req); } - return count; + state->readLen = count; + return true; } /* diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index 0193611b7f..d990432ffe 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -49,7 +49,7 @@ typedef struct WALSegmentContext typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -131,6 +131,20 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ + bool page_verified; /* is the page on the buffer verified? */ + /* ---------------------------------------- * Decoded representation of current record @@ -157,13 +171,6 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - /* last read XLOG position for data currently in readBuf */ WALSegmentContext segcxt; WALOpenSegment seg; diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 0572b24192..0867ef0599 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); diff --git a/src/include/replication/logicalfuncs.h b/src/include/replication/logicalfuncs.h index 012096f183..54291221c3 100644 --- a/src/include/replication/logicalfuncs.h +++ b/src/include/replication/logicalfuncs.h @@ -11,7 +11,7 @@ #include "replication/logical.h" -extern int logical_read_local_xlog_page(XLogReaderState *state, +extern bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); -- 2.23.0 ----Next_Part(Fri_Nov_29_17_14_21_2019_330)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v12-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH v11 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) The current WAL record reader reads page data using a call back function. Although it is not so problematic alone, it would be a problem if we are going to do add tasks like encryption which is performed on page data before WAL reader reads them. To avoid that the record reader facility has to have a new code path corresponds to every new callback, this patch separates page reader from WAL record reading facility by modifying the current WAL record reader to a state machine. As the first step of that change, this patch moves the page reader function out of ReadPageInternal, then the remaining tasks of the function are taken over by the new function XLogNeedData. As the result XLogPageRead directly calls the page reader callback function according to the feedback from XLogNeedData. --- src/backend/access/transam/xlog.c | 16 +- src/backend/access/transam/xlogreader.c | 272 ++++++++++-------- src/backend/access/transam/xlogutils.c | 12 +- .../replication/logical/logicalfuncs.c | 2 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 16 +- src/bin/pg_waldump/pg_waldump.c | 14 +- src/include/access/xlogreader.h | 23 +- src/include/access/xlogutils.h | 2 +- src/include/replication/logicalfuncs.h | 2 +- 10 files changed, 216 insertions(+), 153 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 5f0ee50092..4a6bd6e002 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -884,7 +884,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, int source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr); @@ -4249,7 +4249,6 @@ ReadRecord(XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, XLogRecord *record; XLogPageReadPrivate *private = (XLogPageReadPrivate *) xlogreader->private_data; - /* Pass through parameters to XLogPageRead */ private->fetching_ckpt = fetching_ckpt; private->emode = emode; private->randAccess = (RecPtr != InvalidXLogRecPtr); @@ -11537,7 +11536,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -11596,7 +11595,8 @@ retry: readLen = 0; readSource = 0; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11691,7 +11691,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11705,8 +11706,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index 67418b05f1..388662ade4 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -36,8 +36,8 @@ static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static bool allocate_recordbuf(XLogReaderState *state, uint32 reclength); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool header_inclusive); static void XLogReaderInvalReadState(XLogReaderState *state); static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); @@ -245,7 +245,6 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -297,14 +296,20 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + RecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -330,8 +335,8 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -404,18 +409,25 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) do { + int rest_len = total_len - gotlen; + /* Calculate pointer to beginning of next page */ targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(rest_len, XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -444,21 +456,14 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); - - Assert(pageHeaderSize <= readOff); + Assert (pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); - + Assert (pageHeaderSize + len <= state->readLen); memcpy(buffer, (char *) contdata, len); buffer += len; gotlen += len; @@ -488,9 +493,15 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -533,109 +544,139 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. header_inclusive indicates that + * reqLen is calculated including page header length. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or found + * error. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall call this function + * again after filling the buffer at least with that portion of data and set + * state->readLen to the length of actually loaded data. + * + * If header_inclusive is false, corrects reqLen internally by adding the + * actual page header length and may request caller for new data. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool header_inclusive) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; + uint32 addLen = 0; - Assert((pageptr % XLOG_BLCKSZ) == 0); + /* Some data is loaded, but page header is not verified yet. */ + if (!state->page_verified && + !XLogRecPtrIsInvalid(state->readPagePtr) && state->readLen >= 0) + { + uint32 pageHeaderSize; - XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); - targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + /* just loaded new data so needs to verify page header */ - /* check whether we have all the requested data already */ - if (targetSegNo == state->seg.ws_segno && - targetPageOff == state->segoff && reqLen <= state->readLen) - return state->readLen; + /* The caller must have loaded at least page header */ + Assert (state->readLen >= SizeOfXLogShortPHD); - /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * - * Whenever switching to a new WAL segment, we read the first page of the - * file and validate its header, even if that's not where the target - * record is. This is so that we can check the additional identification - * info that is present in the first page's "long" header. - */ - if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) - { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; + /* + * We have enough data to check the header length. Recheck the loaded + * length against the actual header length. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Request more data if we don't have the full header. */ + if (state->readLen < pageHeaderSize) + { + state->readLen = pageHeaderSize; + return true; + } + + /* Now that we know we have the full header, validate it. */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* That's bad. Force reading the page again. */ + XLogReaderInvalReadState(state); - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); + return false; + } - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->seg.ws_segno, + state->segcxt.ws_segsize); } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * The loaded page may not be the one caller is supposing to read when we + * are verifying the first page of new segment. In that case, skip further + * verification and immediately load the target page. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); + if (state->page_verified && pageptr == state->readPagePtr) + { - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; + /* + * calculate additional length for page header keeping the total + * length within the block size. + */ + if (!header_inclusive) + { + uint32 pageHeaderSize = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); - Assert(readLen >= reqLen); + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; - hdr = (XLogPageHeader) state->readBuf; + Assert(addLen >= 0); + } - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Return if we already have it. */ + if (reqLen + addLen <= state->readLen) + return false; } + /* Data is not in our buffer, request the caller for it. */ + XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); + targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + Assert((pageptr % XLOG_BLCKSZ) == 0); + /* - * Now that we know we have the full header, validate it. + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->seg.ws_segno = targetSegNo; - state->segoff = targetPageOff; - state->readLen = readLen; + state->page_verified = false; - return readLen; + /* + * Whenever switching to a new WAL segment, we read the first page of the + * file and validate its header, even if that's not where the target + * record is. This is so that we can check the additional identification + * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. + */ + if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) + { + /* + * Then we'll see that the targetSegNo now matches the ws_segno, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; + } -err: - XLogReaderInvalReadState(state); - return -1; + /* + * Request the caller to load the page. We need at least a short page + * header so that we can validate it. + */ + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* @@ -644,9 +685,7 @@ err: static void XLogReaderInvalReadState(XLogReaderState *state) { - state->seg.ws_segno = 0; - state->segoff = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -924,7 +963,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -932,7 +970,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * CheckPage() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -940,19 +978,23 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) /* scroll back to page boundary */ targetPagePtr = tmpRecPtr - targetRecOff; - /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; pageHeaderSize = XLogPageHeaderSize(header); - /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) - goto err; + /* we should have read the page header */ + Assert (state->readLen >= pageHeaderSize); /* skip over potential continuation data */ if (header->xlp_info & XLP_FIRST_IS_CONTRECORD) diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index 446760ed6e..060fbc0c4c 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -680,8 +680,8 @@ XLogTruncateRelation(RelFileNode rnode, ForkNumber forkNum, void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { - const XLogRecPtr lastReadPage = (state->seg.ws_segno * - state->segcxt.ws_segsize + state->segoff); + const XLogRecPtr lastReadPage = state->seg.ws_segno * + state->segcxt.ws_segsize + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -813,7 +813,7 @@ wal_segment_open(XLogSegNo nextSegNo, WALSegmentContext *segcxt, * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -915,7 +915,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -933,7 +934,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, WALReadRaiseError(&errinfo); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } /* diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index aa2106b152..4b0e8ea773 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -106,7 +106,7 @@ check_permissions(void) (errmsg("must be superuser or replication role to use replication slots")))); } -int +bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index ac9209747a..e2d64cc2e5 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -762,7 +762,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -782,7 +782,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -812,7 +815,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req XLByteToSeg(targetPagePtr, segno, sendCxt->ws_segsize); CheckXLogRemoved(segno, sendSeg->ws_tli); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index 1d03375a3e..795e84ff9f 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -44,7 +44,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); @@ -228,7 +228,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -283,7 +283,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -296,7 +297,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -309,13 +311,15 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); xlogreader->seg.ws_tli = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index 30a5851d87..9eece44626 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -324,9 +324,9 @@ WALDumpOpenSegment(XLogSegNo nextSegNo, WALSegmentContext *segcxt, /* * XLogReader read_page callback */ -static int -WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, - XLogRecPtr targetPtr, char *readBuff) +static bool +XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, + XLogRecPtr targetPtr, char *readBuff) { XLogDumpPrivate *private = state->private_data; int count = XLOG_BLCKSZ; @@ -341,7 +341,8 @@ WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } @@ -366,7 +367,8 @@ WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, (Size) errinfo.wre_req); } - return count; + state->readLen = count; + return true; } /* @@ -1027,7 +1029,7 @@ main(int argc, char **argv) /* done with argument parsing, do the actual work */ /* we have everything we need, start reading */ - xlogreader_state = XLogReaderAllocate(WalSegSz, waldir, WALDumpReadPage, + xlogreader_state = XLogReaderAllocate(WalSegSz, waldir, XLogDumpReadPage, &private); if (!xlogreader_state) fatal_error("out of memory"); diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index 0193611b7f..d990432ffe 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -49,7 +49,7 @@ typedef struct WALSegmentContext typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -131,6 +131,20 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ + bool page_verified; /* is the page on the buffer verified? */ + /* ---------------------------------------- * Decoded representation of current record @@ -157,13 +171,6 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - /* last read XLOG position for data currently in readBuf */ WALSegmentContext segcxt; WALOpenSegment seg; diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 0572b24192..0867ef0599 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); diff --git a/src/include/replication/logicalfuncs.h b/src/include/replication/logicalfuncs.h index 012096f183..54291221c3 100644 --- a/src/include/replication/logicalfuncs.h +++ b/src/include/replication/logicalfuncs.h @@ -11,7 +11,7 @@ #include "replication/logical.h" -extern int logical_read_local_xlog_page(XLogReaderState *state, +extern bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); -- 2.23.0 ----Next_Part(Wed_Nov_27_12_09_23_2019_240)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v11-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH v7 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) The current WAL record reader reads page data using a call back function. Although it is not so problematic alone, it would be a problem if we are going to do add tasks like encryption which is performed on page data before WAL reader reads them. To avoid that the record reader facility has to have a new code path corresponds to every new callback, this patch separates page reader from WAL record reading facility by modifying the current WAL record reader to a state machine. As the first step of that change, this patch moves the page reader function out of ReadPageInternal, then the remaining tasks of the function are taken over by the new function XLogNeedData. As the result XLogPageRead directly calls the page reader callback function according to the feedback from XLogNeedData. --- src/backend/access/transam/xlog.c | 16 +- src/backend/access/transam/xlogreader.c | 272 ++++++++++++++---------- src/backend/access/transam/xlogutils.c | 12 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 16 +- src/bin/pg_waldump/pg_waldump.c | 8 +- src/include/access/xlogreader.h | 23 +- src/include/access/xlogutils.h | 2 +- 8 files changed, 211 insertions(+), 148 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 7621fc05e2..51c409d00e 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -900,7 +900,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, XLogSource source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, XLogSource source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr); @@ -4285,7 +4285,6 @@ ReadRecord(XLogReaderState *xlogreader, int emode, XLogRecord *record; XLogPageReadPrivate *private = (XLogPageReadPrivate *) xlogreader->private_data; - /* Pass through parameters to XLogPageRead */ private->fetching_ckpt = fetching_ckpt; private->emode = emode; private->randAccess = (xlogreader->ReadRecPtr == InvalidXLogRecPtr); @@ -11660,7 +11659,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -11719,7 +11718,8 @@ retry: readLen = 0; readSource = XLOG_FROM_ANY; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11814,7 +11814,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11828,8 +11829,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index 32f02256ed..2c1500443e 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -36,8 +36,8 @@ static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static bool allocate_recordbuf(XLogReaderState *state, uint32 reclength); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool header_inclusive); static void XLogReaderInvalReadState(XLogReaderState *state); static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); @@ -269,7 +269,6 @@ XLogReadRecord(XLogReaderState *state, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -319,14 +318,20 @@ XLogReadRecord(XLogReaderState *state, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + RecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -352,8 +357,8 @@ XLogReadRecord(XLogReaderState *state, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -426,18 +431,25 @@ XLogReadRecord(XLogReaderState *state, char **errormsg) do { + int rest_len = total_len - gotlen; + /* Calculate pointer to beginning of next page */ targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(rest_len, XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -466,21 +478,14 @@ XLogReadRecord(XLogReaderState *state, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); - - Assert(pageHeaderSize <= readOff); + Assert(pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); - + Assert (pageHeaderSize + len <= state->readLen); memcpy(buffer, (char *) contdata, len); buffer += len; gotlen += len; @@ -510,9 +515,15 @@ XLogReadRecord(XLogReaderState *state, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -555,109 +566,139 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. header_inclusive indicates that + * reqLen is calculated including page header length. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or found + * error. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall call this function + * again after filling the buffer at least with that portion of data and set + * state->readLen to the length of actually loaded data. + * + * If header_inclusive is false, corrects reqLen internally by adding the + * actual page header length and may request caller for new data. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool header_inclusive) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; + uint32 addLen = 0; - Assert((pageptr % XLOG_BLCKSZ) == 0); + /* Some data is loaded, but page header is not verified yet. */ + if (!state->page_verified && + !XLogRecPtrIsInvalid(state->readPagePtr) && state->readLen >= 0) + { + uint32 pageHeaderSize; - XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); - targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + /* just loaded new data so needs to verify page header */ - /* check whether we have all the requested data already */ - if (targetSegNo == state->seg.ws_segno && - targetPageOff == state->segoff && reqLen <= state->readLen) - return state->readLen; + /* The caller must have loaded at least page header */ + Assert (state->readLen >= SizeOfXLogShortPHD); - /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * - * Whenever switching to a new WAL segment, we read the first page of the - * file and validate its header, even if that's not where the target - * record is. This is so that we can check the additional identification - * info that is present in the first page's "long" header. - */ - if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) - { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; + /* + * We have enough data to check the header length. Recheck the loaded + * length against the actual header length. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Request more data if we don't have the full header. */ + if (state->readLen < pageHeaderSize) + { + state->readLen = pageHeaderSize; + return true; + } + + /* Now that we know we have the full header, validate it. */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* That's bad. Force reading the page again. */ + XLogReaderInvalReadState(state); - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); + return false; + } - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->seg.ws_segno, + state->segcxt.ws_segsize); } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * The loaded page may not be the one caller is supposing to read when we + * are verifying the first page of new segment. In that case, skip further + * verification and immediately load the target page. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); + if (state->page_verified && pageptr == state->readPagePtr) + { - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; + /* + * calculate additional length for page header keeping the total + * length within the block size. + */ + if (!header_inclusive) + { + uint32 pageHeaderSize = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); - Assert(readLen >= reqLen); + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; - hdr = (XLogPageHeader) state->readBuf; + Assert(addLen >= 0); + } - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Return if we already have it. */ + if (reqLen + addLen <= state->readLen) + return false; } + /* Data is not in our buffer, request the caller for it. */ + XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); + targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + Assert((pageptr % XLOG_BLCKSZ) == 0); + /* - * Now that we know we have the full header, validate it. + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->seg.ws_segno = targetSegNo; - state->segoff = targetPageOff; - state->readLen = readLen; + state->page_verified = false; - return readLen; + /* + * Whenever switching to a new WAL segment, we read the first page of the + * file and validate its header, even if that's not where the target + * record is. This is so that we can check the additional identification + * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. + */ + if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) + { + /* + * Then we'll see that the targetSegNo now matches the ws_segno, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; + } -err: - XLogReaderInvalReadState(state); - return -1; + /* + * Request the caller to load the page. We need at least a short page + * header so that we can validate it. + */ + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* @@ -666,9 +707,7 @@ err: static void XLogReaderInvalReadState(XLogReaderState *state) { - state->seg.ws_segno = 0; - state->segoff = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -949,7 +988,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -957,7 +995,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * XLogNeedData() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -965,19 +1003,23 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) /* scroll back to page boundary */ targetPagePtr = tmpRecPtr - targetRecOff; - /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; pageHeaderSize = XLogPageHeaderSize(header); - /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) - goto err; + /* we should have read the page header */ + Assert (state->readLen >= pageHeaderSize); /* skip over potential continuation data */ if (header->xlp_info & XLP_FIRST_IS_CONTRECORD) diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index b217ffa52f..47676bf800 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -685,8 +685,8 @@ XLogTruncateRelation(RelFileNode rnode, ForkNumber forkNum, void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { - const XLogRecPtr lastReadPage = (state->seg.ws_segno * - state->segcxt.ws_segsize + state->segoff); + const XLogRecPtr lastReadPage = state->seg.ws_segno * + state->segcxt.ws_segsize + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -818,7 +818,7 @@ wal_segment_open(XLogSegNo nextSegNo, WALSegmentContext * segcxt, * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -920,7 +920,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -938,7 +939,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, WALReadRaiseError(&errinfo); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } /* diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 76ec3c7dd0..c66ea308d8 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -762,7 +762,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -782,7 +782,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -812,7 +815,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req XLByteToSeg(targetPagePtr, segno, sendCxt->ws_segsize); CheckXLogRemoved(segno, sendSeg->ws_tli); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index eb61cb8803..78ee9f3faa 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -44,7 +44,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); @@ -227,7 +227,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -282,7 +282,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -295,7 +296,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -308,13 +310,15 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); xlogreader->seg.ws_tli = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index 279acfa044..443fe33599 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -322,7 +322,7 @@ WALDumpOpenSegment(XLogSegNo nextSegNo, WALSegmentContext *segcxt, /* * XLogReader read_page callback */ -static int +static bool WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetPtr, char *readBuff) { @@ -339,7 +339,8 @@ WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } @@ -364,7 +365,8 @@ WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, (Size) errinfo.wre_req); } - return count; + state->readLen = count; + return true; } /* diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index 4582196e18..6ad953eea3 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -51,7 +51,7 @@ typedef struct WALSegmentContext typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -134,6 +134,20 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ + bool page_verified; /* is the page on the buffer verified? */ + /* ---------------------------------------- * Decoded representation of current record @@ -160,13 +174,6 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - /* last read XLOG position for data currently in readBuf */ WALSegmentContext segcxt; WALOpenSegment seg; diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 5181a077d9..dc7d894e5d 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); -- 2.18.2 ----Next_Part(Tue_Mar_24_18_24_13_2020_275)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v7-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH v9 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) The current WAL record reader reads page data using a call back function. Although it is not so problematic alone, it would be a problem if we are going to do add tasks like encryption which is performed on page data before WAL reader reads them. To avoid that the record reader facility has to have a new code path corresponds to every new callback, this patch separates page reader from WAL record reading facility by modifying the current WAL record reader to a state machine. As the first step of that change, this patch moves the page reader function out of ReadPageInternal, then the remaining tasks of the function are taken over by the new function XLogNeedData. As the result XLogPageRead directly calls the page reader callback function according to the feedback from XLogNeedData. --- src/backend/access/transam/xlog.c | 16 +- src/backend/access/transam/xlogreader.c | 273 ++++++++++-------- src/backend/access/transam/xlogutils.c | 10 +- .../replication/logical/logicalfuncs.c | 2 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 16 +- src/bin/pg_waldump/pg_waldump.c | 8 +- src/include/access/xlogreader.h | 23 +- src/include/access/xlogutils.h | 2 +- src/include/replication/logicalfuncs.h | 2 +- src/test/recovery/t/011_crash_recovery.pl | 1 + 11 files changed, 213 insertions(+), 150 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index b602e28f61..a7630c643a 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -884,7 +884,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, int source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr); @@ -4249,7 +4249,6 @@ ReadRecord(XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, XLogRecord *record; XLogPageReadPrivate *private = (XLogPageReadPrivate *) xlogreader->private_data; - /* Pass through parameters to XLogPageRead */ private->fetching_ckpt = fetching_ckpt; private->emode = emode; private->randAccess = (RecPtr != InvalidXLogRecPtr); @@ -11540,7 +11539,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -11599,7 +11598,8 @@ retry: readLen = 0; readSource = 0; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11694,7 +11694,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11708,8 +11709,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index c8b0d2303d..66f3bc5597 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -34,8 +34,8 @@ static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static bool allocate_recordbuf(XLogReaderState *state, uint32 reclength); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool header_inclusive); static void XLogReaderInvalReadState(XLogReaderState *state); static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); @@ -244,7 +244,6 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -296,15 +295,20 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, - targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + RecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -330,8 +334,8 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -404,18 +408,25 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) do { + int rest_len = total_len - gotlen; + /* Calculate pointer to beginning of next page */ targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(rest_len, XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -444,21 +455,14 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); - - Assert(pageHeaderSize <= readOff); + Assert (pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); - + Assert (pageHeaderSize + len <= state->readLen); memcpy(buffer, (char *) contdata, len); buffer += len; gotlen += len; @@ -488,9 +492,15 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -533,109 +543,139 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. header_inclusive indicates that + * reqLen is calculated including page header length. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or found + * error. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall call this function + * again after filling the buffer at least with that portion of data and set + * state->readLen to the length of actually loaded data. + * + * If header_inclusive is false, corrects reqLen internally by adding the + * actual page header length and may request caller for new data. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool header_inclusive) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; + uint32 addLen = 0; - Assert((pageptr % XLOG_BLCKSZ) == 0); + /* Some data is loaded, but page header is not verified yet. */ + if (!state->page_verified && + !XLogRecPtrIsInvalid(state->readPagePtr) && state->readLen >= 0) + { + uint32 pageHeaderSize; - XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); - targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + /* just loaded new data so needs to verify page header */ - /* check whether we have all the requested data already */ - if (targetSegNo == state->seg.ws_segno && - targetPageOff == state->seg.ws_off && reqLen <= state->readLen) - return state->readLen; + /* The caller must have loaded at least page header */ + Assert (state->readLen >= SizeOfXLogShortPHD); - /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * - * Whenever switching to a new WAL segment, we read the first page of the - * file and validate its header, even if that's not where the target - * record is. This is so that we can check the additional identification - * info that is present in the first page's "long" header. - */ - if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) - { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; + /* + * We have enough data to check the header length. Recheck the loaded + * length against the actual header length. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Request more data if we don't have the full header. */ + if (state->readLen < pageHeaderSize) + { + state->readLen = pageHeaderSize; + return true; + } + + /* Now that we know we have the full header, validate it. */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* That's bad. Force reading the page again. */ + XLogReaderInvalReadState(state); - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); + return false; + } - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->seg.ws_segno, + state->segcxt.ws_segsize); } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * The loaded page may not be the one caller is supposing to read when we + * are verifying the first page of new segment. In that case, skip further + * verification and immediately load the target page. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); + if (state->page_verified && pageptr == state->readPagePtr) + { - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; + /* + * calculate additional length for page header keeping the total + * length within the block size. + */ + if (!header_inclusive) + { + uint32 pageHeaderSize = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); - Assert(readLen >= reqLen); + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; - hdr = (XLogPageHeader) state->readBuf; + Assert(addLen >= 0); + } - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; + /* Return if we already have it. */ + if (reqLen + addLen <= state->readLen) + return false; } + /* Data is not in our buffer, request the caller for it. */ + XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); + targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + Assert((pageptr % XLOG_BLCKSZ) == 0); + /* - * Now that we know we have the full header, validate it. + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->seg.ws_segno = targetSegNo; - state->seg.ws_off = targetPageOff; - state->readLen = readLen; + state->page_verified = false; - return readLen; + /* + * Whenever switching to a new WAL segment, we read the first page of the + * file and validate its header, even if that's not where the target + * record is. This is so that we can check the additional identification + * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. + */ + if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) + { + /* + * Then we'll see that the targetSegNo now matches the ws_segno, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; + } -err: - XLogReaderInvalReadState(state); - return -1; + /* + * Request the caller to load the page. We need at least a short page + * header so that we can validate it. + */ + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* @@ -644,9 +684,7 @@ err: static void XLogReaderInvalReadState(XLogReaderState *state) { - state->seg.ws_segno = 0; - state->seg.ws_off = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -924,7 +962,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -932,7 +969,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * CheckPage() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -940,19 +977,23 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) /* scroll back to page boundary */ targetPagePtr = tmpRecPtr - targetRecOff; - /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; pageHeaderSize = XLogPageHeaderSize(header); - /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) - goto err; + /* we should have read the page header */ + Assert (state->readLen >= pageHeaderSize); /* skip over potential continuation data */ if (header->xlp_info & XLP_FIRST_IS_CONTRECORD) diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index 5f1e5ba75d..a19726a96e 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -803,7 +803,7 @@ void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { const XLogRecPtr lastReadPage = state->seg.ws_segno * - state->segcxt.ws_segsize + state->seg.ws_off; + state->segcxt.ws_segsize + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -907,7 +907,7 @@ XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wa * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -1007,7 +1007,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -1024,5 +1025,6 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, XLOG_BLCKSZ); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index d1cf80d441..310cd9d8cf 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -114,7 +114,7 @@ check_permissions(void) (errmsg("must be superuser or replication role to use replication slots")))); } -int +bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index b0ebe5039c..3ea71a0f84 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -760,7 +760,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -778,7 +778,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -788,7 +791,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* now actually read the data, we know it's there */ XLogRead(sendCxt, cur_page, targetPagePtr, XLOG_BLCKSZ); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index 264a8f4db5..8aecd1adc7 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -46,7 +46,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); @@ -230,7 +230,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -285,7 +285,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -298,7 +299,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -311,13 +313,15 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); xlogreader->seg.ws_tli = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index b79208cd73..6e424bd8e1 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -406,7 +406,7 @@ XLogDumpXLogRead(const char *directory, TimeLineID timeline_id, /* * XLogReader read_page callback */ -static int +static bool XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetPtr, char *readBuff) { @@ -422,14 +422,16 @@ XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } XLogDumpXLogRead(state->segcxt.ws_dir, private->timeline, targetPagePtr, readBuff, count); - return count; + state->readLen = count; + return true; } /* diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index 1bbee386e8..8b747d465f 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -50,7 +50,7 @@ typedef struct WALSegmentContext typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -132,6 +132,20 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ + bool page_verified; /* is the page on the buffer verified? */ + /* ---------------------------------------- * Decoded representation of current record @@ -158,13 +172,6 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - /* last read XLOG position for data currently in readBuf */ WALSegmentContext segcxt; WALOpenSegment seg; diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 2df98e45b2..47b65463f9 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); diff --git a/src/include/replication/logicalfuncs.h b/src/include/replication/logicalfuncs.h index 012096f183..54291221c3 100644 --- a/src/include/replication/logicalfuncs.h +++ b/src/include/replication/logicalfuncs.h @@ -11,7 +11,7 @@ #include "replication/logical.h" -extern int logical_read_local_xlog_page(XLogReaderState *state, +extern bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); diff --git a/src/test/recovery/t/011_crash_recovery.pl b/src/test/recovery/t/011_crash_recovery.pl index 526a3481fb..c78912571e 100644 --- a/src/test/recovery/t/011_crash_recovery.pl +++ b/src/test/recovery/t/011_crash_recovery.pl @@ -55,6 +55,7 @@ is($node->safe_psql('postgres', qq[SELECT txid_status('$xid');]), # Crash and restart the postmaster $node->stop('immediate'); +print "HOGEEEEEEEEEEEE\n"; $node->start; # Make sure we really got a new xid -- 2.23.0 ----Next_Part(Thu_Oct_24_14_51_01_2019_720)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v9-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH v8 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) The current WAL record reader reads page data using a call back function. Although it is not so problematic alone, it would be a problem if we are going to do add tasks like encryption which is performed on page data before WAL reader reads them. To avoid that the record reader facility has to have a new code path corresponds to every new callback, this patch separates page reader from WAL record reading facility by modifying the current WAL record reader to a state machine. As the first step of that change, this patch moves the page reader function out of ReadPageInternal, then the remaining tasks of the function are taken over by the new function XLogNeedData. As the result XLogPageRead directly calls the page reader callback function according to the feedback from XLogNeedData. --- src/backend/access/transam/xlog.c | 16 +- src/backend/access/transam/xlogreader.c | 306 +++++++++++++++---------- src/backend/access/transam/xlogutils.c | 10 +- src/backend/replication/logical/logicalfuncs.c | 2 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 16 +- src/bin/pg_waldump/pg_waldump.c | 8 +- src/include/access/xlogreader.h | 23 +- src/include/access/xlogutils.h | 2 +- src/include/replication/logicalfuncs.h | 2 +- src/test/recovery/t/011_crash_recovery.pl | 1 + 11 files changed, 239 insertions(+), 157 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 6c69eb6dd7..5dcb2e500c 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -884,7 +884,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, int source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr); @@ -4249,7 +4249,6 @@ ReadRecord(XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, XLogRecord *record; XLogPageReadPrivate *private = (XLogPageReadPrivate *) xlogreader->private_data; - /* Pass through parameters to XLogPageRead */ private->fetching_ckpt = fetching_ckpt; private->emode = emode; private->randAccess = (RecPtr != InvalidXLogRecPtr); @@ -11522,7 +11521,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -11581,7 +11580,8 @@ retry: readLen = 0; readSource = 0; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11676,7 +11676,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11690,8 +11691,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index 27c27303d6..900a628752 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -34,8 +34,8 @@ static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static bool allocate_recordbuf(XLogReaderState *state, uint32 reclength); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool header_inclusive); static void XLogReaderInvalReadState(XLogReaderState *state); static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); @@ -104,7 +104,7 @@ XLogReaderAllocate(int wal_segment_size, const char *waldir, /* system_identifier initialized to zeroes above */ state->private_data = private_data; /* ReadRecPtr and EndRecPtr initialized to zeroes above */ - /* readSegNo, readOff, readLen, readPageTLI initialized to zeroes above */ + /* readSegNo, readLen, readPageTLI initialized to zeroes above */ state->errormsg_buf = palloc_extended(MAX_ERRORMSG_LEN + 1, MCXT_ALLOC_NO_OOM); if (!state->errormsg_buf) @@ -245,7 +245,6 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -297,15 +296,20 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, - targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + RecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -331,8 +335,8 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -405,18 +409,25 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) do { + int rest_len = total_len - gotlen; + /* Calculate pointer to beginning of next page */ targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(rest_len, XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -445,21 +456,14 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); - - Assert(pageHeaderSize <= readOff); + Assert (pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); - + Assert (pageHeaderSize + len <= state->readLen); memcpy(buffer, (char *) contdata, len); buffer += len; gotlen += len; @@ -489,9 +493,15 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -534,109 +544,158 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. header_inclusive indicates that + * reqLen is calculated including page header length. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or found + * error. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall call this function + * again after filling the buffer at least with that portion of data and set + * state->readLen to the length of actually loaded data. + * + * If header_inclusive is false, corrects reqLen internally by adding the + * actual page header length and may request caller for new data. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool header_inclusive) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; - - Assert((pageptr % XLOG_BLCKSZ) == 0); - - XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); - targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + uint32 addLen = 0; /* check whether we have all the requested data already */ - if (targetSegNo == state->seg.ws_segno && - targetPageOff == state->seg.ws_off && reqLen <= state->readLen) - return state->readLen; + if (state->page_verified && pageptr == state->readPagePtr) + { + if (!header_inclusive) + { + /* + * calculate additional length for page header so that the total + * length doesn't exceed the block size. + */ + uint32 pageHeaderSize = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; + } + + if (reqLen + addLen <= state->readLen) + return false; + } + + if (!state->page_verified && + !XLogRecPtrIsInvalid(state->readPagePtr) && state->readLen >= 0) + { + uint32 pageHeaderSize; + + /* just loaded new data so needs to verify page header */ + + /* The caller must have loaded at least page header */ + Assert (state->readLen >= SizeOfXLogShortPHD); + + /* + * We have enough data to check the header length. Recheck the loaded + * length if it is a long header if any. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + /* Request more data if we don't have the full header. */ + if (state->readLen < pageHeaderSize) + { + state->readLen = pageHeaderSize; + return true; + } + + /* Now that we know we have the full header, validate it. */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* That's bad. Force reading the page again. */ + XLogReaderInvalReadState(state); + + return false; + } + + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->seg.ws_segno, + state->segcxt.ws_segsize); + + /* + * The loaded page may not be the one caller is supposing to read when + * we are verifying the first page of new segment. In that case, skip + * further verification and immediately load the target page. + */ + if (pageptr == state->readPagePtr) + { + + /* + * calculate additional length for page header keeping the total + * length within the block size. + */ + if (!header_inclusive) + { + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; + + Assert(addLen >= 0); + } + + /* Return if we already have it. */ + if (reqLen + addLen <= state->readLen) + return false; + } + } + + /* Data is not in our buffer, request the caller for it. */ + XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); + targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + Assert((pageptr % XLOG_BLCKSZ) == 0); + + /* + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. + */ + state->page_verified = false; /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * * Whenever switching to a new WAL segment, we read the first page of the * file and validate its header, even if that's not where the target * record is. This is so that we can check the additional identification * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. */ if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; - - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); - - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + /* + * Then we'll see that the targetSegNo now matches the ws_segno, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * Request the caller to load the page. We need at least a short page + * header so that we can validate it. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); - - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; - - Assert(readLen >= reqLen); - - hdr = (XLogPageHeader) state->readBuf; - - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - } - - /* - * Now that we know we have the full header, validate it. - */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->seg.ws_segno = targetSegNo; - state->seg.ws_off = targetPageOff; - state->readLen = readLen; - - return readLen; - -err: - XLogReaderInvalReadState(state); - return -1; + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* @@ -645,9 +704,7 @@ err: static void XLogReaderInvalReadState(XLogReaderState *state) { - state->seg.ws_segno = 0; - state->seg.ws_off = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -925,7 +982,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -933,7 +989,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * CheckPage() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -941,19 +997,23 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) /* scroll back to page boundary */ targetPagePtr = tmpRecPtr - targetRecOff; - /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; pageHeaderSize = XLogPageHeaderSize(header); - /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) - goto err; + /* we should have read the page header */ + Assert (state->readLen >= pageHeaderSize); /* skip over potential continuation data */ if (header->xlp_info & XLP_FIRST_IS_CONTRECORD) diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index 5f1e5ba75d..a19726a96e 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -803,7 +803,7 @@ void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { const XLogRecPtr lastReadPage = state->seg.ws_segno * - state->segcxt.ws_segsize + state->seg.ws_off; + state->segcxt.ws_segsize + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -907,7 +907,7 @@ XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wa * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -1007,7 +1007,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -1024,5 +1025,6 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, XLOG_BLCKSZ); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index d1cf80d441..310cd9d8cf 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -114,7 +114,7 @@ check_permissions(void) (errmsg("must be superuser or replication role to use replication slots")))); } -int +bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index eb4a98cc91..0809ceaeb8 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -760,7 +760,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -778,7 +778,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -788,7 +791,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* now actually read the data, we know it's there */ XLogRead(sendCxt, cur_page, targetPagePtr, XLOG_BLCKSZ); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index 264a8f4db5..8aecd1adc7 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -46,7 +46,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); @@ -230,7 +230,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -285,7 +285,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -298,7 +299,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -311,13 +313,15 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); xlogreader->seg.ws_tli = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index b79208cd73..6e424bd8e1 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -406,7 +406,7 @@ XLogDumpXLogRead(const char *directory, TimeLineID timeline_id, /* * XLogReader read_page callback */ -static int +static bool XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetPtr, char *readBuff) { @@ -422,14 +422,16 @@ XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } XLogDumpXLogRead(state->segcxt.ws_dir, private->timeline, targetPagePtr, readBuff, count); - return count; + state->readLen = count; + return true; } /* diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index 1bbee386e8..8b747d465f 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -50,7 +50,7 @@ typedef struct WALSegmentContext typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -132,6 +132,20 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ + bool page_verified; /* is the page on the buffer verified? */ + /* ---------------------------------------- * Decoded representation of current record @@ -158,13 +172,6 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - /* last read XLOG position for data currently in readBuf */ WALSegmentContext segcxt; WALOpenSegment seg; diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 2df98e45b2..47b65463f9 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); diff --git a/src/include/replication/logicalfuncs.h b/src/include/replication/logicalfuncs.h index 012096f183..54291221c3 100644 --- a/src/include/replication/logicalfuncs.h +++ b/src/include/replication/logicalfuncs.h @@ -11,7 +11,7 @@ #include "replication/logical.h" -extern int logical_read_local_xlog_page(XLogReaderState *state, +extern bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); diff --git a/src/test/recovery/t/011_crash_recovery.pl b/src/test/recovery/t/011_crash_recovery.pl index 526a3481fb..c78912571e 100644 --- a/src/test/recovery/t/011_crash_recovery.pl +++ b/src/test/recovery/t/011_crash_recovery.pl @@ -55,6 +55,7 @@ is($node->safe_psql('postgres', qq[SELECT txid_status('$xid');]), # Crash and restart the postmaster $node->stop('immediate'); +print "HOGEEEEEEEEEEEE\n"; $node->start; # Make sure we really got a new xid -- 2.16.3 ----Next_Part(Fri_Sep_27_12_07_26_2019_308)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v8-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH v7 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) The current WAL record reader reads page data using a call back function. Although it is not so problematic alone, it would be a problem if we are going to do add tasks like encryption which is performed on page data before WAL reader reads them. To avoid that the record reader facility has to have a new code path corresponds to every new callback, this patch separates page reader from WAL record reading facility by modifying the current WAL record reader to a state machine. As the first step of that change, this patch moves the page reader function out of ReadPageInternal, then the remaining tasks of the function are taken over by the new function XLogNeedData. As the result XLogPageRead directly calls the page reader callback function according to the feedback from XLogNeedData. --- src/backend/access/transam/xlog.c | 16 +- src/backend/access/transam/xlogreader.c | 332 +++++++++++++++---------- src/backend/access/transam/xlogutils.c | 10 +- src/backend/replication/logical/logicalfuncs.c | 2 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 16 +- src/bin/pg_waldump/pg_waldump.c | 8 +- src/include/access/xlogreader.h | 23 +- src/include/access/xlogutils.h | 2 +- src/include/replication/logicalfuncs.h | 2 +- 10 files changed, 259 insertions(+), 162 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 6c69eb6dd7..5dcb2e500c 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -884,7 +884,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, int source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr); @@ -4249,7 +4249,6 @@ ReadRecord(XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, XLogRecord *record; XLogPageReadPrivate *private = (XLogPageReadPrivate *) xlogreader->private_data; - /* Pass through parameters to XLogPageRead */ private->fetching_ckpt = fetching_ckpt; private->emode = emode; private->randAccess = (RecPtr != InvalidXLogRecPtr); @@ -11522,7 +11521,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -11581,7 +11580,8 @@ retry: readLen = 0; readSource = 0; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11676,7 +11676,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11690,8 +11691,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index 27c27303d6..c2bb664f07 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -34,9 +34,9 @@ static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static bool allocate_recordbuf(XLogReaderState *state, uint32 reclength); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); -static void XLogReaderInvalReadState(XLogReaderState *state); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool header_inclusive); +static void XLogReaderDiscardReadingPage(XLogReaderState *state); static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); static bool ValidXLogRecord(XLogReaderState *state, XLogRecord *record, @@ -104,7 +104,7 @@ XLogReaderAllocate(int wal_segment_size, const char *waldir, /* system_identifier initialized to zeroes above */ state->private_data = private_data; /* ReadRecPtr and EndRecPtr initialized to zeroes above */ - /* readSegNo, readOff, readLen, readPageTLI initialized to zeroes above */ + /* readSegNo, readLen, readPageTLI initialized to zeroes above */ state->errormsg_buf = palloc_extended(MAX_ERRORMSG_LEN + 1, MCXT_ALLOC_NO_OOM); if (!state->errormsg_buf) @@ -245,7 +245,6 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -297,15 +296,20 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, - targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + RecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have loaded at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -331,8 +335,8 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -405,18 +409,25 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) do { + int rest_len = total_len - gotlen; + /* Calculate pointer to beginning of next page */ targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(rest_len, XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -445,21 +456,14 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); - - Assert(pageHeaderSize <= readOff); + Assert (pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); - + Assert (pageHeaderSize + len <= state->readLen); memcpy(buffer, (char *) contdata, len); buffer += len; gotlen += len; @@ -489,9 +493,15 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -525,7 +535,7 @@ err: * Invalidate the read state. We might read from a different source after * failure. */ - XLogReaderInvalReadState(state); + XLogReaderDiscardReadingPage(state); if (state->errormsg_buf[0] != '\0') *errormsg = state->errormsg_buf; @@ -534,120 +544,183 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. header_inclusive indicates that + * reqLen is calculated including page header length. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or found + * error. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall call this function + * again after filling the buffer at least with that portion of data and set + * state->readLen to the length of actually loaded data. + * + * If header_inclusive is false, corrects reqLen internally by adding the + * actual page header length and may request caller for new data. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool header_inclusive) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; - - Assert((pageptr % XLOG_BLCKSZ) == 0); - - XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); - targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + uint32 addLen = 0; /* check whether we have all the requested data already */ - if (targetSegNo == state->seg.ws_segno && - targetPageOff == state->seg.ws_off && reqLen <= state->readLen) - return state->readLen; + if (state->page_verified && pageptr == state->readPagePtr) + { + if (!header_inclusive) + { + /* + * calculate additional length for page header so that the total + * length doesn't exceed the block size. + */ + uint32 pageHeaderSize = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; + } + + if (reqLen + addLen <= state->readLen) + return false; + } + + /* Haven't loaded any data yet? Then request it. */ + if (XLogRecPtrIsInvalid(state->readPagePtr) || + state->readPagePtr != pageptr || state->readLen < 0) + { + state->readPagePtr = pageptr; + state->readLen = Max(reqLen, SizeOfXLogShortPHD); + state->page_verified = false; + return true; + } + + if (!state->page_verified) + { + uint32 pageHeaderSize; + uint32 addLen = 0; + + /* just loaded new data so needs to verify page header */ + + /* The caller must have loaded at least page header */ + Assert(state->readLen >= SizeOfXLogShortPHD); + + /* + * We have enough data to check the header length. Recheck the loaded + * length if it is a long header if any. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + /* + * If we have not loaded a page so far, readLen is zero, which is + * shorter than pageHeaderSize here. + */ + if (state->readLen < pageHeaderSize) + { + state->readPagePtr = pageptr; + state->readLen = pageHeaderSize; + return true; + } + + /* + * Now that we know we have the full header, validate it. + */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* force reading the page again. */ + XLogReaderDiscardReadingPage(state); + + return false; + } + + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->seg.ws_segno, + state->segcxt.ws_segsize); + + /* + * calculate additional length for page header so that the total + * length doesn't exceed the block size. + */ + if (!header_inclusive) + { + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; + + Assert(addLen >= 0); + } + + /* Usually we have requested data loaded in buffer here. */ + if (pageptr == state->readPagePtr && reqLen + addLen <= state->readLen) + return false; + + /* + * In the case the page is requested for the first record in the page, + * the previous request have been made not counting page header + * length. Request again for the same page with the length known to be + * needed. Otherwise we don't know the header length of the new page. + */ + if (pageptr != state->readPagePtr) + addLen = 0; + } + + /* Data is not in our buffer, make a new load request to the caller. */ + XLByteToSeg(pageptr, targetSegNo, state->segcxt.ws_segsize); + targetPageOff = XLogSegmentOffset(pageptr, state->segcxt.ws_segsize); + Assert((pageptr % XLOG_BLCKSZ) == 0); + + /* + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. + */ + state->page_verified = false; /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * * Whenever switching to a new WAL segment, we read the first page of the * file and validate its header, even if that's not where the target * record is. This is so that we can check the additional identification * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. */ if (targetSegNo != state->seg.ws_segno && targetPageOff != 0) { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; - - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); - - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + /* + * Then we'll see that the targetSegNo now matches the ws_segno, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * Request the caller to load the requested page. We need at least a short + * page header so that we can validate it. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); - - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; - - Assert(readLen >= reqLen); - - hdr = (XLogPageHeader) state->readBuf; - - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf); - if (readLen < 0) - goto err; - } - - /* - * Now that we know we have the full header, validate it. - */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->seg.ws_segno = targetSegNo; - state->seg.ws_off = targetPageOff; - state->readLen = readLen; - - return readLen; - -err: - XLogReaderInvalReadState(state); - return -1; + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* - * Invalidate the xlogreader's read state to force a re-read. + * Invalidate current reading page buffer */ static void -XLogReaderInvalReadState(XLogReaderState *state) +XLogReaderDiscardReadingPage(XLogReaderState *state) { - state->seg.ws_segno = 0; - state->seg.ws_off = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -925,7 +998,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -933,7 +1005,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * CheckPage() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -941,19 +1013,23 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) /* scroll back to page boundary */ targetPagePtr = tmpRecPtr - targetRecOff; - /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; pageHeaderSize = XLogPageHeaderSize(header); - /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) - goto err; + /* we should have read the page header */ + Assert (state->readLen >= pageHeaderSize); /* skip over potential continuation data */ if (header->xlp_info & XLP_FIRST_IS_CONTRECORD) @@ -1010,7 +1086,7 @@ out: /* Reset state to what we had before finding the record */ state->ReadRecPtr = saved_state.ReadRecPtr; state->EndRecPtr = saved_state.EndRecPtr; - XLogReaderInvalReadState(state); + XLogReaderDiscardReadingPage(state); return found; } diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index 5f1e5ba75d..a19726a96e 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -803,7 +803,7 @@ void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { const XLogRecPtr lastReadPage = state->seg.ws_segno * - state->segcxt.ws_segsize + state->seg.ws_off; + state->segcxt.ws_segsize + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -907,7 +907,7 @@ XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wa * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -1007,7 +1007,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -1024,5 +1025,6 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, XLOG_BLCKSZ); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index d1cf80d441..310cd9d8cf 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -114,7 +114,7 @@ check_permissions(void) (errmsg("must be superuser or replication role to use replication slots")))); } -int +bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index eb4a98cc91..0809ceaeb8 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -760,7 +760,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page) { @@ -778,7 +778,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -788,7 +791,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* now actually read the data, we know it's there */ XLogRead(sendCxt, cur_page, targetPagePtr, XLOG_BLCKSZ); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index 264a8f4db5..8aecd1adc7 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -46,7 +46,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf); @@ -230,7 +230,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf) { @@ -285,7 +285,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -298,7 +299,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -311,13 +313,15 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); xlogreader->seg.ws_tli = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index b79208cd73..6e424bd8e1 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -406,7 +406,7 @@ XLogDumpXLogRead(const char *directory, TimeLineID timeline_id, /* * XLogReader read_page callback */ -static int +static bool XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetPtr, char *readBuff) { @@ -422,14 +422,16 @@ XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } XLogDumpXLogRead(state->segcxt.ws_dir, private->timeline, targetPagePtr, readBuff, count); - return count; + state->readLen = count; + return true; } /* diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index 1bbee386e8..8b747d465f 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -50,7 +50,7 @@ typedef struct WALSegmentContext typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -132,6 +132,20 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ + bool page_verified; /* is the page on the buffer verified? */ + /* ---------------------------------------- * Decoded representation of current record @@ -158,13 +172,6 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - /* last read XLOG position for data currently in readBuf */ WALSegmentContext segcxt; WALOpenSegment seg; diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 2df98e45b2..47b65463f9 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); diff --git a/src/include/replication/logicalfuncs.h b/src/include/replication/logicalfuncs.h index 012096f183..54291221c3 100644 --- a/src/include/replication/logicalfuncs.h +++ b/src/include/replication/logicalfuncs.h @@ -11,7 +11,7 @@ #include "replication/logical.h" -extern int logical_read_local_xlog_page(XLogReaderState *state, +extern bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page); -- 2.16.3 ----Next_Part(Wed_Sep_25_15_50_32_2019_576)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v7-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH v6 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. @ 2019-09-05 11:21 Kyotaro Horiguchi <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Kyotaro Horiguchi @ 2019-09-05 11:21 UTC (permalink / raw) The current WAL record reader reads page data using a call back function. Although it is not so problematic alone, it would be a problem if we are going to do add tasks like encryption which is performed on page data before WAL reader reads them. To avoid that the record reader facility has to have a new code path corresponds to every new callback, this patch separates page reader from WAL record reading facility by modifying the current WAL record reader to a state machine. As the first step of that change, this patch moves the page reader function out of ReadPageInternal, then the remaining tasks of the function are taken over by the new function XLogNeedData. As the result XLogPageRead directly calls the page reader callback function according to the feedback from XLogNeedData. --- src/backend/access/transam/xlog.c | 16 +- src/backend/access/transam/xlogreader.c | 336 +++++++++++++++---------- src/backend/access/transam/xlogutils.c | 10 +- src/backend/replication/logical/logicalfuncs.c | 4 +- src/backend/replication/walsender.c | 10 +- src/bin/pg_rewind/parsexlog.c | 17 +- src/bin/pg_waldump/pg_waldump.c | 8 +- src/include/access/xlogreader.h | 26 +- src/include/access/xlogutils.h | 2 +- src/include/replication/logicalfuncs.h | 2 +- 10 files changed, 265 insertions(+), 166 deletions(-) diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 6876537b62..d7f899e738 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -884,7 +884,7 @@ static bool InstallXLogFileSegment(XLogSegNo *segno, char *tmppath, static int XLogFileRead(XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk); static int XLogFileReadAnyTLI(XLogSegNo segno, int emode, int source); -static int XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *readTLI); static bool WaitForWALToBecomeAvailable(XLogRecPtr RecPtr, bool randAccess, @@ -4249,7 +4249,6 @@ ReadRecord(XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, XLogRecord *record; XLogPageReadPrivate *private = (XLogPageReadPrivate *) xlogreader->private_data; - /* Pass through parameters to XLogPageRead */ private->fetching_ckpt = fetching_ckpt; private->emode = emode; private->randAccess = (RecPtr != InvalidXLogRecPtr); @@ -11521,7 +11520,7 @@ CancelBackup(void) * XLogPageRead() to try fetching the record from another source, or to * sleep and retry. */ -static int +static bool XLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *readTLI) { @@ -11580,7 +11579,8 @@ retry: readLen = 0; readSource = 0; - return -1; + xlogreader->readLen = -1; + return false; } } @@ -11675,7 +11675,8 @@ retry: goto next_record_is_invalid; } - return readLen; + xlogreader->readLen = readLen; + return true; next_record_is_invalid: lastSourceFailed = true; @@ -11689,8 +11690,9 @@ next_record_is_invalid: /* In standby-mode, keep trying */ if (StandbyMode) goto retry; - else - return -1; + + xlogreader->readLen = -1; + return false; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index a66e3324b1..12a52159a9 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -34,9 +34,9 @@ static void report_invalid_record(XLogReaderState *state, const char *fmt,...) pg_attribute_printf(2, 3); static bool allocate_recordbuf(XLogReaderState *state, uint32 reclength); -static int ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, - int reqLen); -static void XLogReaderInvalReadState(XLogReaderState *state); +static bool XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, + int reqLen, bool header_inclusive); +static void XLogReaderDiscardReadingPage(XLogReaderState *state); static bool ValidXLogRecordHeader(XLogReaderState *state, XLogRecPtr RecPtr, XLogRecPtr PrevRecPtr, XLogRecord *record, bool randAccess); static bool ValidXLogRecord(XLogReaderState *state, XLogRecord *record, @@ -101,7 +101,7 @@ XLogReaderAllocate(int wal_segment_size, XLogPageReadCB pagereadfunc, /* system_identifier initialized to zeroes above */ state->private_data = private_data; /* ReadRecPtr and EndRecPtr initialized to zeroes above */ - /* readSegNo, readOff, readLen, readPageTLI initialized to zeroes above */ + /* readSegNo, readLen, readPageTLI initialized to zeroes above */ state->errormsg_buf = palloc_extended(MAX_ERRORMSG_LEN + 1, MCXT_ALLOC_NO_OOM); if (!state->errormsg_buf) @@ -225,7 +225,6 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) uint32 targetRecOff; uint32 pageHeaderSize; bool gotheader; - int readOff; /* * randAccess indicates whether to verify the previous-record pointer of @@ -277,15 +276,21 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) * byte to cover the whole record header, or at least the part of it that * fits on the same page. */ - readOff = ReadPageInternal(state, - targetPagePtr, - Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + SizeOfXLogRecord, XLOG_BLCKSZ), + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + RecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + + if (!state->page_verified) goto err; /* - * ReadPageInternal always returns at least the page header, so we can - * examine it now. + * We have loaded at least the page header, so we can examine it now. */ pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); if (targetRecOff == 0) @@ -311,8 +316,8 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) goto err; } - /* ReadPageInternal has verified the page header */ - Assert(pageHeaderSize <= readOff); + /* XLogNeedData has verified the page header */ + Assert(pageHeaderSize <= state->readLen); /* * Read the record length. @@ -385,18 +390,26 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) do { + int rest_len = total_len - gotlen; + /* Calculate pointer to beginning of next page */ targetPagePtr += XLOG_BLCKSZ; /* Wait for the next page to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(total_len - gotlen + SizeOfXLogShortPHD, - XLOG_BLCKSZ)); + while (XLogNeedData(state, targetPagePtr, + Min(rest_len, XLOG_BLCKSZ), + false)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } - if (readOff < 0) + if (!state->page_verified) goto err; - Assert(SizeOfXLogShortPHD <= readOff); + Assert(SizeOfXLogShortPHD <= state->readLen); /* Check that the continuation on next page looks valid */ pageHeader = (XLogPageHeader) state->readBuf; @@ -425,21 +438,14 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) /* Append the continuation from this page to the buffer */ pageHeaderSize = XLogPageHeaderSize(pageHeader); - if (readOff < pageHeaderSize) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize); - - Assert(pageHeaderSize <= readOff); + Assert (pageHeaderSize <= state->readLen); contdata = (char *) state->readBuf + pageHeaderSize; len = XLOG_BLCKSZ - pageHeaderSize; if (pageHeader->xlp_rem_len < len) len = pageHeader->xlp_rem_len; - if (readOff < pageHeaderSize + len) - readOff = ReadPageInternal(state, targetPagePtr, - pageHeaderSize + len); - + Assert (pageHeaderSize + len <= state->readLen); memcpy(buffer, (char *) contdata, len); buffer += len; gotlen += len; @@ -469,9 +475,16 @@ XLogReadRecord(XLogReaderState *state, XLogRecPtr RecPtr, char **errormsg) else { /* Wait for the record data to become available */ - readOff = ReadPageInternal(state, targetPagePtr, - Min(targetRecOff + total_len, XLOG_BLCKSZ)); - if (readOff < 0) + while (XLogNeedData(state, targetPagePtr, + Min(targetRecOff + total_len, XLOG_BLCKSZ), true)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + + if (!state->page_verified) goto err; /* Record does not cross a page boundary */ @@ -505,7 +518,7 @@ err: * Invalidate the read state. We might read from a different source after * failure. */ - XLogReaderInvalReadState(state); + XLogReaderDiscardReadingPage(state); if (state->errormsg_buf[0] != '\0') *errormsg = state->errormsg_buf; @@ -514,120 +527,183 @@ err: } /* - * Read a single xlog page including at least [pageptr, reqLen] of valid data - * via the read_page() callback. + * Checks that an xlog page loaded in state->readBuf is including at least + * [pageptr, reqLen] and the page is valid. header_inclusive indicates that + * reqLen is calculated including page header length. * - * Returns -1 if the required page cannot be read for some reason; errormsg_buf - * is set in that case (unless the error occurs in the read_page callback). + * Returns false if the buffer already contains the requested data, or found + * error. state->page_verified is set to true for the former and false for the + * latter. * - * We fetch the page from a reader-local cache if we know we have the required - * data and if there hasn't been any error since caching the data. + * Otherwise returns true and requests data loaded onto state->readBuf by + * state->readPagePtr and state->readLen. The caller shall call this function + * again after filling the buffer at least with that portion of data and set + * state->readLen to the length of actually loaded data. + * + * If header_inclusive is false, corrects reqLen internally by adding the + * actual page header length and may request caller for new data. */ -static int -ReadPageInternal(XLogReaderState *state, XLogRecPtr pageptr, int reqLen) +static bool +XLogNeedData(XLogReaderState *state, XLogRecPtr pageptr, int reqLen, + bool header_inclusive) { - int readLen; uint32 targetPageOff; XLogSegNo targetSegNo; - XLogPageHeader hdr; - - Assert((pageptr % XLOG_BLCKSZ) == 0); - - XLByteToSeg(pageptr, targetSegNo, state->wal_segment_size); - targetPageOff = XLogSegmentOffset(pageptr, state->wal_segment_size); + uint32 addLen = 0; /* check whether we have all the requested data already */ - if (targetSegNo == state->readSegNo && targetPageOff == state->readOff && - reqLen <= state->readLen) - return state->readLen; + if (state->page_verified && pageptr == state->readPagePtr) + { + if (!header_inclusive) + { + /* + * calculate additional length for page header so that the total + * length doesn't exceed the block size. + */ + uint32 pageHeaderSize = + XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; + } + + if (reqLen + addLen <= state->readLen) + return false; + } + + /* Haven't loaded any data yet? Then request it. */ + if (XLogRecPtrIsInvalid(state->readPagePtr) || + state->readPagePtr != pageptr || state->readLen < 0) + { + state->readPagePtr = pageptr; + state->readLen = Max(reqLen, SizeOfXLogShortPHD); + state->page_verified = false; + return true; + } + + if (!state->page_verified) + { + uint32 pageHeaderSize; + uint32 addLen = 0; + + /* just loaded new data so needs to verify page header */ + + /* The caller must have loaded at least page header */ + Assert(state->readLen >= SizeOfXLogShortPHD); + + /* + * We have enough data to check the header length. Recheck the loaded + * length if it is a long header if any. + */ + pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) state->readBuf); + + /* + * If we have not loaded a page so far, readLen is zero, which is + * shorter than pageHeaderSize here. + */ + if (state->readLen < pageHeaderSize) + { + state->readPagePtr = pageptr; + state->readLen = pageHeaderSize; + return true; + } + + /* + * Now that we know we have the full header, validate it. + */ + if (!XLogReaderValidatePageHeader(state, state->readPagePtr, + (char *) state->readBuf)) + { + /* force reading the page again. */ + XLogReaderDiscardReadingPage(state); + + return false; + } + + state->page_verified = true; + + XLByteToSeg(state->readPagePtr, state->readSegNo, + state->wal_segment_size); + + /* + * calculate additional length for page header so that the total + * length doesn't exceed the block size. + */ + if (!header_inclusive) + { + addLen = pageHeaderSize; + if (reqLen + pageHeaderSize <= XLOG_BLCKSZ) + addLen = pageHeaderSize; + else + addLen = XLOG_BLCKSZ - reqLen; + + Assert(addLen >= 0); + } + + /* Usually we have requested data loaded in buffer here. */ + if (pageptr == state->readPagePtr && reqLen + addLen <= state->readLen) + return false; + + /* + * In the case the page is requested for the first record in the page, + * the previous request have been made not counting page header + * length. Request again for the same page with the length known to be + * needed. Otherwise we don't know the header length of the new page. + */ + if (pageptr != state->readPagePtr) + addLen = 0; + } + + /* Data is not in our buffer, make a new load request to the caller. */ + XLByteToSeg(pageptr, targetSegNo, state->wal_segment_size); + targetPageOff = XLogSegmentOffset(pageptr, state->wal_segment_size); + Assert((pageptr % XLOG_BLCKSZ) == 0); + + /* + * Every time we request to load new data of a page to the caller, even if + * we looked at a part of it before, we need to do verification on the next + * invocation as the caller might now be rereading data from a different + * source. + */ + state->page_verified = false; /* - * Data is not in our buffer. - * - * Every time we actually read the page, even if we looked at parts of it - * before, we need to do verification as the read_page callback might now - * be rereading data from a different source. - * * Whenever switching to a new WAL segment, we read the first page of the * file and validate its header, even if that's not where the target * record is. This is so that we can check the additional identification * info that is present in the first page's "long" header. + * Don't do this if the caller requested the first page in the segment. */ if (targetSegNo != state->readSegNo && targetPageOff != 0) { - XLogRecPtr targetSegmentPtr = pageptr - targetPageOff; - - readLen = state->read_page(state, targetSegmentPtr, XLOG_BLCKSZ, - state->currRecPtr, - state->readBuf, &state->readPageTLI); - if (readLen < 0) - goto err; - - /* we can be sure to have enough WAL available, we scrolled back */ - Assert(readLen == XLOG_BLCKSZ); - - if (!XLogReaderValidatePageHeader(state, targetSegmentPtr, - state->readBuf)) - goto err; + /* + * Then we'll see that the targetSegNo now matches the readSegNo, and + * will not come back here, but will request the actual target page. + */ + state->readPagePtr = pageptr - targetPageOff; + state->readLen = XLOG_BLCKSZ; + return true; } /* - * First, read the requested data length, but at least a short page header - * so that we can validate it. + * Request the caller to load the requested page. We need at least a short + * page header so that we can validate it. */ - readLen = state->read_page(state, pageptr, Max(reqLen, SizeOfXLogShortPHD), - state->currRecPtr, - state->readBuf, &state->readPageTLI); - if (readLen < 0) - goto err; - - Assert(readLen <= XLOG_BLCKSZ); - - /* Do we have enough data to check the header length? */ - if (readLen <= SizeOfXLogShortPHD) - goto err; - - Assert(readLen >= reqLen); - - hdr = (XLogPageHeader) state->readBuf; - - /* still not enough */ - if (readLen < XLogPageHeaderSize(hdr)) - { - readLen = state->read_page(state, pageptr, XLogPageHeaderSize(hdr), - state->currRecPtr, - state->readBuf, &state->readPageTLI); - if (readLen < 0) - goto err; - } - - /* - * Now that we know we have the full header, validate it. - */ - if (!XLogReaderValidatePageHeader(state, pageptr, (char *) hdr)) - goto err; - - /* update read state information */ - state->readSegNo = targetSegNo; - state->readOff = targetPageOff; - state->readLen = readLen; - - return readLen; - -err: - XLogReaderInvalReadState(state); - return -1; + state->readPagePtr = pageptr; + state->readLen = Max(reqLen + addLen, SizeOfXLogShortPHD); + return true; } /* - * Invalidate the xlogreader's read state to force a re-read. + * Invalidate current reading page buffer */ static void -XLogReaderInvalReadState(XLogReaderState *state) +XLogReaderDiscardReadingPage(XLogReaderState *state) { - state->readSegNo = 0; - state->readOff = 0; - state->readLen = 0; + state->readPagePtr = InvalidXLogRecPtr; } /* @@ -905,7 +981,6 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) XLogRecPtr targetPagePtr; int targetRecOff; uint32 pageHeaderSize; - int readLen; /* * Compute targetRecOff. It should typically be equal or greater than @@ -913,7 +988,7 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) * that, except when caller has explicitly specified the offset that * falls somewhere there or when we are skipping multi-page * continuation record. It doesn't matter though because - * ReadPageInternal() is prepared to handle that and will read at + * CheckPage() is prepared to handle that and will read at * least short page-header worth of data */ targetRecOff = tmpRecPtr % XLOG_BLCKSZ; @@ -921,19 +996,24 @@ XLogFindNextRecord(XLogReaderState *state, XLogRecPtr RecPtr) /* scroll back to page boundary */ targetPagePtr = tmpRecPtr - targetRecOff; - /* Read the page containing the record */ - readLen = ReadPageInternal(state, targetPagePtr, targetRecOff); - if (readLen < 0) + while(XLogNeedData(state, targetPagePtr, targetRecOff, + targetRecOff != 0)) + { + if (!state->read_page(state, state->readPagePtr, state->readLen, + state->ReadRecPtr, state->readBuf, + &state->readPageTLI)) + break; + } + + if (!state->page_verified) goto err; header = (XLogPageHeader) state->readBuf; pageHeaderSize = XLogPageHeaderSize(header); - /* make sure we have enough data for the page header */ - readLen = ReadPageInternal(state, targetPagePtr, pageHeaderSize); - if (readLen < 0) - goto err; + /* we should have read the page header */ + Assert (state->readLen >= pageHeaderSize); /* skip over potential continuation data */ if (header->xlp_info & XLP_FIRST_IS_CONTRECORD) @@ -990,7 +1070,7 @@ out: /* Reset state to what we had before finding the record */ state->ReadRecPtr = saved_state.ReadRecPtr; state->EndRecPtr = saved_state.EndRecPtr; - XLogReaderInvalReadState(state); + XLogReaderDiscardReadingPage(state); return found; } diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c index 1fc39333f1..dad9074b9f 100644 --- a/src/backend/access/transam/xlogutils.c +++ b/src/backend/access/transam/xlogutils.c @@ -803,7 +803,7 @@ void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength) { const XLogRecPtr lastReadPage = state->readSegNo * - state->wal_segment_size + state->readOff; + state->wal_segment_size + state->readLen; Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0); Assert(wantLength <= XLOG_BLCKSZ); @@ -907,7 +907,7 @@ XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wa * exists for normal backends, so we have to do a check/sleep/repeat style of * loop for now. */ -int +bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI) @@ -1009,7 +1009,8 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, else if (targetPagePtr + reqLen > read_upto) { /* not enough data there */ - return -1; + state->readLen = -1; + return false; } else { @@ -1026,5 +1027,6 @@ read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, XLOG_BLCKSZ); /* number of valid bytes in the buffer */ - return count; + state->readLen = count; + return true; } diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index d974400d6e..7210a940bd 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -114,12 +114,12 @@ check_permissions(void) (errmsg("must be superuser or replication role to use replication slots")))); } -int +bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI) { return read_local_xlog_page(state, targetPagePtr, reqLen, - targetRecPtr, cur_page, pageTLI); + targetRecPtr, cur_page, pageTLI); } /* diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 23870a25a5..cc35e2a04d 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -761,7 +761,7 @@ StartReplication(StartReplicationCmd *cmd) * which has to do a plain sleep/busy loop, because the walsender's latch gets * set every time WAL is flushed. */ -static int +static bool logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI) { @@ -779,7 +779,10 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* fail if not (implies we are going to shut down) */ if (flushptr < targetPagePtr + reqLen) - return -1; + { + state->readLen = -1; + return false; + } if (targetPagePtr + XLOG_BLCKSZ <= flushptr) count = XLOG_BLCKSZ; /* more than one block available */ @@ -789,7 +792,8 @@ logical_read_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int req /* now actually read the data, we know it's there */ XLogRead(cur_page, targetPagePtr, XLOG_BLCKSZ); - return count; + state->readLen = count; + return true; } /* diff --git a/src/bin/pg_rewind/parsexlog.c b/src/bin/pg_rewind/parsexlog.c index 63c3879ead..4df53964e4 100644 --- a/src/bin/pg_rewind/parsexlog.c +++ b/src/bin/pg_rewind/parsexlog.c @@ -47,7 +47,7 @@ typedef struct XLogPageReadPrivate int tliIndex; } XLogPageReadPrivate; -static int SimpleXLogPageRead(XLogReaderState *xlogreader, +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *pageTLI); @@ -235,7 +235,7 @@ findLastCheckpoint(const char *datadir, XLogRecPtr forkptr, int tliIndex, } /* XLogReader callback function, to read a WAL page */ -static int +static bool SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf, TimeLineID *pageTLI) @@ -290,7 +290,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (xlogreadfd < 0) { pg_log_error("could not open file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } } @@ -303,7 +304,8 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, if (lseek(xlogreadfd, (off_t) targetPageOff, SEEK_SET) < 0) { pg_log_error("could not seek in file \"%s\": %m", xlogfpath); - return -1; + xlogreader->readLen = -1; + return false; } @@ -316,13 +318,16 @@ SimpleXLogPageRead(XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, pg_log_error("could not read file \"%s\": read %d of %zu", xlogfpath, r, (Size) XLOG_BLCKSZ); - return -1; + xlogreader->readLen = -1; + return false; } Assert(targetSegNo == xlogreadsegno); *pageTLI = targetHistory[private->tliIndex].tli; - return XLOG_BLCKSZ; + + xlogreader->readLen = XLOG_BLCKSZ; + return true; } /* diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c index b95d467805..96d1f36ebc 100644 --- a/src/bin/pg_waldump/pg_waldump.c +++ b/src/bin/pg_waldump/pg_waldump.c @@ -421,7 +421,7 @@ XLogDumpXLogRead(const char *directory, TimeLineID timeline_id, /* * XLogReader read_page callback */ -static int +static bool XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetPtr, char *readBuff, TimeLineID *curFileTLI) { @@ -437,14 +437,16 @@ XLogDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, else { private->endptr_reached = true; - return -1; + state->readLen = -1; + return false; } } XLogDumpXLogRead(private->inpath, private->timeline, targetPagePtr, readBuff, count); - return count; + state->readLen = count; + return true; } /* diff --git a/src/include/access/xlogreader.h b/src/include/access/xlogreader.h index 735b1bd2fd..6de7c19a2a 100644 --- a/src/include/access/xlogreader.h +++ b/src/include/access/xlogreader.h @@ -34,7 +34,7 @@ typedef struct XLogReaderState XLogReaderState; /* Function type definition for the read_page callback */ -typedef int (*XLogPageReadCB) (XLogReaderState *xlogreader, +typedef bool (*XLogPageReadCB) (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, @@ -123,6 +123,18 @@ struct XLogReaderState XLogRecPtr ReadRecPtr; /* start of last record read */ XLogRecPtr EndRecPtr; /* end+1 of last record read */ + /* ---------------------------------------- + * Communication with page reader + * readBuf is XLOG_BLCKSZ bytes, valid up to at least readLen bytes. + * ---------------------------------------- + */ + /* variables to communicate with page reader */ + XLogRecPtr readPagePtr; /* page pointer to read */ + int32 readLen; /* bytes requested to reader, or actual bytes + * read by reader, which must be larger than + * the request, or -1 on error */ + TimeLineID readPageTLI; /* TLI for data currently in readBuf */ + char *readBuf; /* buffer to store data */ /* ---------------------------------------- * Decoded representation of current record @@ -149,17 +161,9 @@ struct XLogReaderState * ---------------------------------------- */ - /* - * Buffer for currently read page (XLOG_BLCKSZ bytes, valid up to at least - * readLen bytes) - */ - char *readBuf; - uint32 readLen; - - /* last read segment, segment offset, TLI for data currently in readBuf */ + /* last read segment and segment offset for data currently in readBuf */ + bool page_verified; XLogSegNo readSegNo; - uint32 readOff; - TimeLineID readPageTLI; /* * beginning of prior page read, and its TLI. Doesn't necessarily diff --git a/src/include/access/xlogutils.h b/src/include/access/xlogutils.h index 4105b59904..0842af9f95 100644 --- a/src/include/access/xlogutils.h +++ b/src/include/access/xlogutils.h @@ -47,7 +47,7 @@ extern Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, extern Relation CreateFakeRelcacheEntry(RelFileNode rnode); extern void FreeFakeRelcacheEntry(Relation fakerel); -extern int read_local_xlog_page(XLogReaderState *state, +extern bool read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI); diff --git a/src/include/replication/logicalfuncs.h b/src/include/replication/logicalfuncs.h index a9c178a9e6..8e52b1f4aa 100644 --- a/src/include/replication/logicalfuncs.h +++ b/src/include/replication/logicalfuncs.h @@ -11,7 +11,7 @@ #include "replication/logical.h" -extern int logical_read_local_xlog_page(XLogReaderState *state, +extern bool logical_read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, TimeLineID *pageTLI); -- 2.16.3 ----Next_Part(Tue_Sep_10_17_40_54_2019_177)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v6-0002-Move-page-reader-out-of-XLogReadRecord.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-04-05 09:45 Michael Paquier <[email protected]> 2 siblings, 1 reply; 32+ messages in thread From: Michael Paquier @ 2022-04-05 09:45 UTC (permalink / raw) To: Andres Freund <[email protected]>; +Cc: Nitin Jadhav <[email protected]>; Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 18, 2022 at 05:15:56PM -0700, Andres Freund wrote: > Have you measured the performance effects of this? On fast storage with large > shared_buffers I've seen these loops in profiles. It's probably fine, but it'd > be good to verify that. I am wondering if we could make the function inlined at some point. We could also play it safe and only update the counters every N loops instead. > This view is depressingly complicated. Added up the view definitions for > the already existing pg_stat_progress* views add up to a measurable part of > the size of an empty database: Yeah. I think that what's proposed could be simplified, and we had better remove the fields that are not that useful. First, do we have any need for next_flags? Second, is the start LSN really necessary for monitoring purposes? Not all the information in the first parameter is useful, as well. For example "shutdown" will never be seen as it is not possible to use a session at this stage, no? There is also no gain in having "immediate", "flush-all", "force" and "wait" (for this one if the checkpoint is requested the session doing the work knows this information already). A last thing is that we may gain in visibility by having more attributes as an effect of splitting param2. On thing that would make sense is to track the reason why the checkpoint was triggered separately (aka wal and time). Should we use a text[] instead to list all the parameters instead? Using a space-separated list of items is not intuitive IMO, and callers of this routine will likely parse that. Shouldn't we also track the number of files flushed in each sub-step? In some deployments you could have a large number of 2PC files and such. We may want more information on such matters. + WHEN 3 THEN 'checkpointing replication slots' + WHEN 4 THEN 'checkpointing logical replication snapshot files' + WHEN 5 THEN 'checkpointing logical rewrite mapping files' + WHEN 6 THEN 'checkpointing replication origin' + WHEN 7 THEN 'checkpointing commit log pages' + WHEN 8 THEN 'checkpointing commit time stamp pages' There is a lot of "checkpointing" here. All those terms could be shorter without losing their meaning. This patch still needs some work, so I am marking it as RwF for now. -- Michael Attachments: [application/pgp-signature] signature.asc (833B, ../../YkwPyAoTq%[email protected]/2-signature.asc) download ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-06-06 06:03 Nitin Jadhav <[email protected]> 2 siblings, 0 replies; 32+ messages in thread From: Nitin Jadhav @ 2022-06-06 06:03 UTC (permalink / raw) To: Julien Rouhaud <[email protected]>; +Cc: Matthias van de Meent <[email protected]>; Bharath Rupireddy <[email protected]>; Ashutosh Sharma <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, Here is the update patch which fixes the previous comments discussed in this thread. I am sorry for the long gap in the discussion. Kindly let me know if I have missed any of the comments or anything new. Thanks & Regards, Nitin Jadhav On Fri, Mar 18, 2022 at 4:52 PM Nitin Jadhav <[email protected]> wrote: > > > > > I don't get it. The checkpoint flags and the view flags (set by > > > > pgstat_progrss_update*) are different, so why can't we add this flag to the > > > > view flags? The fact that checkpointer.c doesn't update the passed flag and > > > > instead look in the shmem to see if CHECKPOINT_IMMEDIATE has been set since is > > > > an implementation detail, and the view shouldn't focus on which flags were > > > > initially passed to the checkpointer but instead which flags the checkpointer > > > > is actually enforcing, as that's what the user should be interested in. If you > > > > want to store it in another field internally but display it in the view with > > > > the rest of the flags, I'm fine with it. > > > > > > Just to be in sync with the way code behaves, it is better not to > > > update the next checkpoint request's CHECKPOINT_IMMEDIATE with the > > > current checkpoint 'flags' field. Because the current checkpoint > > > starts with a different set of flags and when there is a new request > > > (with CHECKPOINT_IMMEDIATE), it just processes the pending operations > > > quickly to take up next requests. If we update this information in the > > > 'flags' field of the view, it says that the current checkpoint is > > > started with CHECKPOINT_IMMEDIATE which is not true. > > > > Which is why I suggested to only take into account CHECKPOINT_REQUESTED (to > > be able to display that a new checkpoint was requested) > > I will take care in the next patch. > > > > Hence I had > > > thought of adding a new field ('next flags' or 'upcoming flags') which > > > contain all the flag values of new checkpoint requests. This field > > > indicates whether the current checkpoint is throttled or not and also > > > it indicates there are new requests. > > > > I'm not opposed to having such a field, I'm opposed to having a view with "the > > current checkpoint is throttled but if there are some flags in the next > > checkpoint flags and those flags contain checkpoint immediate then the current > > checkpoint isn't actually throttled anymore" behavior. > > I understand your point and I also agree that it becomes difficult for > the user to understand the context. > > > and > > CHECKPOINT_IMMEDIATE, to be able to display that the current checkpoint isn't > > throttled anymore if it were. > > > > I still don't understand why you want so much to display "how the checkpoint > > was initially started" rather than "how the checkpoint is really behaving right > > now". The whole point of having a progress view is to have something dynamic > > that reflects the current activity. > > As of now I will not consider adding this information to the view. If > required and nobody opposes having this included in the 'flags' field > of the view, then I will consider adding. > > Thanks & Regards, > Nitin Jadhav > > On Mon, Mar 14, 2022 at 5:16 PM Julien Rouhaud <[email protected]> wrote: > > > > On Mon, Mar 14, 2022 at 03:16:50PM +0530, Nitin Jadhav wrote: > > > > > I am not suggesting > > > > > removing the existing 'flags' field of pg_stat_progress_checkpoint > > > > > view and adding a new field 'throttled'. The content of the 'flags' > > > > > field remains the same. I was suggesting replacing the 'next_flags' > > > > > field with 'throttled' field since the new request with > > > > > CHECKPOINT_IMMEDIATE flag enabled will affect the current checkpoint. > > > > > > > > Are you saying that this new throttled flag will only be set by the overloaded > > > > flags in ckpt_flags? > > > > > > Yes. you are right. > > > > > > > So you can have a checkpoint with a CHECKPOINT_IMMEDIATE > > > > flags that's throttled, and a checkpoint without the CHECKPOINT_IMMEDIATE flag > > > > that's not throttled? > > > > > > I think it's the reverse. A checkpoint with a CHECKPOINT_IMMEDIATE > > > flags that's not throttled (disables delays between writes) and a > > > checkpoint without the CHECKPOINT_IMMEDIATE flag that's throttled > > > (enables delays between writes) > > > > Yes that's how it's supposed to work, but my point was that your suggested > > 'throttled' flag could say the opposite, which is bad. > > > > > > I don't get it. The checkpoint flags and the view flags (set by > > > > pgstat_progrss_update*) are different, so why can't we add this flag to the > > > > view flags? The fact that checkpointer.c doesn't update the passed flag and > > > > instead look in the shmem to see if CHECKPOINT_IMMEDIATE has been set since is > > > > an implementation detail, and the view shouldn't focus on which flags were > > > > initially passed to the checkpointer but instead which flags the checkpointer > > > > is actually enforcing, as that's what the user should be interested in. If you > > > > want to store it in another field internally but display it in the view with > > > > the rest of the flags, I'm fine with it. > > > > > > Just to be in sync with the way code behaves, it is better not to > > > update the next checkpoint request's CHECKPOINT_IMMEDIATE with the > > > current checkpoint 'flags' field. Because the current checkpoint > > > starts with a different set of flags and when there is a new request > > > (with CHECKPOINT_IMMEDIATE), it just processes the pending operations > > > quickly to take up next requests. If we update this information in the > > > 'flags' field of the view, it says that the current checkpoint is > > > started with CHECKPOINT_IMMEDIATE which is not true. > > > > Which is why I suggested to only take into account CHECKPOINT_REQUESTED (to > > be able to display that a new checkpoint was requested) and > > CHECKPOINT_IMMEDIATE, to be able to display that the current checkpoint isn't > > throttled anymore if it were. > > > > I still don't understand why you want so much to display "how the checkpoint > > was initially started" rather than "how the checkpoint is really behaving right > > now". The whole point of having a progress view is to have something dynamic > > that reflects the current activity. > > > > > Hence I had > > > thought of adding a new field ('next flags' or 'upcoming flags') which > > > contain all the flag values of new checkpoint requests. This field > > > indicates whether the current checkpoint is throttled or not and also > > > it indicates there are new requests. > > > > I'm not opposed to having such a field, I'm opposed to having a view with "the > > current checkpoint is throttled but if there are some flags in the next > > checkpoint flags and those flags contain checkpoint immediate then the current > > checkpoint isn't actually throttled anymore" behavior. Attachments: [application/octet-stream] v6-0001-pg_stat_progress_checkpoint-view.patch (38.0K, ../../CAMm1aWZ9eP==mk_UcO_LkYTx9oJLd98KYBbbsxp6r9DeDPbZ4g@mail.gmail.com/2-v6-0001-pg_stat_progress_checkpoint-view.patch) download | inline diff: From 104184f6cba7dfe33eb710de8158b21e6937bf51 Mon Sep 17 00:00:00 2001 From: Nitin Jadhav <[email protected]> Date: Mon, 6 Jun 2022 05:55:06 +0000 Subject: [PATCH] pg_stat_progress_checkpoint-view --- doc/src/sgml/monitoring.sgml | 405 +++++++++++++++++++++++++- doc/src/sgml/ref/checkpoint.sgml | 7 + doc/src/sgml/wal.sgml | 6 +- src/backend/access/transam/xlog.c | 102 +++++++ src/backend/catalog/system_views.sql | 51 ++++ src/backend/postmaster/checkpointer.c | 15 +- src/backend/storage/buffer/bufmgr.c | 7 + src/backend/storage/sync/sync.c | 6 + src/backend/utils/adt/pgstatfuncs.c | 2 + src/include/commands/progress.h | 38 +++ src/include/utils/backend_progress.h | 3 +- src/test/regress/expected/rules.out | 70 +++++ 12 files changed, 706 insertions(+), 6 deletions(-) diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 4549c2560e..5fe0ba4492 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -414,6 +414,13 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser See <xref linkend='copy-progress-reporting'/>. </entry> </row> + + <row> + <entry><structname>pg_stat_progress_checkpoint</structname><indexterm><primary>pg_stat_progress_checkpoint</primary></indexterm></entry> + <entry>One row only, showing the progress of the checkpoint. + See <xref linkend='checkpoint-progress-reporting'/>. + </entry> + </row> </tbody> </tgroup> </table> @@ -5736,7 +5743,7 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid, which support progress reporting are <command>ANALYZE</command>, <command>CLUSTER</command>, <command>CREATE INDEX</command>, <command>VACUUM</command>, - <command>COPY</command>, + <command>COPY</command>, <command>CHECKPOINT</command> and <xref linkend="protocol-replication-base-backup"/> (i.e., replication command that <xref linkend="app-pgbasebackup"/> issues to take a base backup). @@ -7024,6 +7031,402 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid, </table> </sect2> + <sect2 id="checkpoint-progress-reporting"> + <title>Checkpoint Progress Reporting</title> + + <indexterm> + <primary>pg_stat_progress_checkpoint</primary> + </indexterm> + + <para> + Whenever the checkpoint operation is running, the + <structname>pg_stat_progress_checkpoint</structname> view will contain a + single row indicating the progress of the checkpoint. The tables below + describe the information that will be reported and provide information about + how to interpret it. + </para> + + <table id="pg-stat-progress-checkpoint-view" xreflabel="pg_stat_progress_checkpoint"> + <title><structname>pg_stat_progress_checkpoint</structname> View</title> + <tgroup cols="1"> + <thead> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + Column Type + </para> + <para> + Description + </para></entry> + </row> + </thead> + + <tbody> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>pid</structfield> <type>integer</type> + </para> + <para> + Process ID of the checkpointer process. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>type</structfield> <type>text</type> + </para> + <para> + Type of the checkpoint. See <xref linkend="checkpoint-types"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>flags</structfield> <type>text</type> + </para> + <para> + Flags of the checkpoint. See <xref linkend="checkpoint-flags"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>start_lsn</structfield> <type>text</type> + </para> + <para> + The checkpoint start location. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>start_time</structfield> <type>timestamp with time zone</type> + </para> + <para> + Start time of the checkpoint. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>phase</structfield> <type>text</type> + </para> + <para> + Current processing phase. See <xref linkend="checkpoint-phases"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_total</structfield> <type>bigint</type> + </para> + <para> + Total number of buffers to be written. This is estimated and reported + as of the beginning of buffer write operation. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_processed</structfield> <type>bigint</type> + </para> + <para> + Number of buffers processed. This counter increases when the targeted + buffer is processed. This number will eventually become equal to + <literal>buffers_total</literal> when the checkpoint is + complete. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_written</structfield> <type>bigint</type> + </para> + <para> + Number of buffers written. This counter only advances when the targeted + buffers is written. Note that some of the buffers are processed but may + not required to be written. So this count will always be less than or + equal to <literal>buffers_total</literal>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>files_total</structfield> <type>bigint</type> + </para> + <para> + Total number of files to be synced. This is estimated and reported as of + the beginning of sync operation. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>files_synced</structfield> <type>bigint</type> + </para> + <para> + Number of files synced. This counter advances when the targeted file is + synced. This number will eventually become equal to + <literal>files_total</literal> when the checkpoint is complete. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>new_requests</structfield> <type>text</type> + </para> + <para> + True if any of the backend is requested for a checkpoint while the + current checkpoint is in progress, False otherwise. + </para></entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-types"> + <title>Checkpoint Types</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Types</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>checkpoint</literal></entry> + <entry> + The current operation is checkpoint. + </entry> + </row> + <row> + <entry><literal>restartpoint</literal></entry> + <entry> + The current operation is restartpoint. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-flags"> + <title>Checkpoint Flags</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Flags</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>shutdown</literal></entry> + <entry> + The checkpoint is for shutdown. + </entry> + </row> + <row> + <entry><literal>end-of-recovery</literal></entry> + <entry> + The checkpoint is for end-of-recovery. + </entry> + </row> + <row> + <entry><literal>immediate</literal></entry> + <entry> + The checkpoint happens without delays. + </entry> + </row> + <row> + <entry><literal>force</literal></entry> + <entry> + The checkpoint is started because some operation (for which the + checkpoint is necessary) forced a checkpoint. + </entry> + </row> + <row> + <entry><literal>flush all</literal></entry> + <entry> + The checkpoint flushes all pages, including those belonging to unlogged + tables. + </entry> + </row> + <row> + <entry><literal>wait</literal></entry> + <entry> + The operations which requested the checkpoint waits for completion + before returning. + </entry> + </row> + <row> + <entry><literal>requested</literal></entry> + <entry> + The checkpoint request has been made. + </entry> + </row> + <row> + <entry><literal>wal</literal></entry> + <entry> + The checkpoint is started because <literal>max_wal_size</literal> is + reached. + </entry> + </row> + <row> + <entry><literal>time</literal></entry> + <entry> + The checkpoint is started because <literal>checkpoint_timeout</literal> + expired. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-phases"> + <title>Checkpoint Phases</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Phase</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>initializing</literal></entry> + <entry> + The checkpointer process is preparing to begin the checkpoint operation. + This phase is expected to be very brief. + </entry> + </row> + <row> + <entry><literal>getting virtual transaction IDs</literal></entry> + <entry> + The checkpointer process is getting the virtual transaction IDs that + are delaying the checkpoint. + </entry> + </row> + <row> + <entry><literal>checkpointing replication slots</literal></entry> + <entry> + The checkpointer process is currently flushing all the replication slots + to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing logical replication snapshot files</literal></entry> + <entry> + The checkpointer process is currently removing all the serialized + snapshot files that are not required anymore. + </entry> + </row> + <row> + <entry><literal>checkpointing logical rewrite mapping files</literal></entry> + <entry> + The checkpointer process is currently removing unwanted or flushing + required logical rewrite mapping files. + </entry> + </row> + <row> + <entry><literal>checkpointing replication origin</literal></entry> + <entry> + The checkpointer process is currently performing a checkpoint of each + replication origin's progress with respect to the replayed remote LSN. + </entry> + </row> + <row> + <entry><literal>checkpointing commit log pages</literal></entry> + <entry> + The checkpointer process is currently writing commit log pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing commit time stamp pages</literal></entry> + <entry> + The checkpointer process is currently writing commit time stamp pages to + disk. + </entry> + </row> + <row> + <entry><literal>checkpointing subtransaction pages</literal></entry> + <entry> + The checkpointer process is currently writing subtransaction pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing multixact pages</literal></entry> + <entry> + The checkpointer process is currently writing multixact pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing predicate lock pages</literal></entry> + <entry> + The checkpointer process is currently writing predicate lock pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing buffers</literal></entry> + <entry> + The checkpointer process is currently writing buffers to disk. + </entry> + </row> + <row> + <entry><literal>processing file sync requests</literal></entry> + <entry> + The checkpointer process is currently processing file sync requests. + </entry> + </row> + <row> + <entry><literal>performing two phase checkpoint</literal></entry> + <entry> + The checkpointer process is currently performing two phase checkpoint. + </entry> + </row> + <row> + <entry><literal>performing post checkpoint cleanup</literal></entry> + <entry> + The checkpointer process is currently performing post checkpoint cleanup. + It removes any lingering files that can be safely removed. + </entry> + </row> + <row> + <entry><literal>invalidating replication slots</literal></entry> + <entry> + The checkpointer process is currently invalidating replication slots. + </entry> + </row> + <row> + <entry><literal>recycling old WAL files</literal></entry> + <entry> + The checkpointer process is currently recycling old WAL files. + </entry> + </row> + <row> + <entry><literal>truncating subtransactions</literal></entry> + <entry> + The checkpointer process is currently removing the subtransaction + segments. + </entry> + </row> + <row> + <entry><literal>finalizing</literal></entry> + <entry> + The checkpointer process is finalizing the checkpoint operation. + </entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + </sect1> <sect1 id="dynamic-trace"> diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml index 1cebc03d15..f33db50cfc 100644 --- a/doc/src/sgml/ref/checkpoint.sgml +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -56,6 +56,13 @@ CHECKPOINT the <link linkend="predefined-roles-table"><literal>pg_checkpointer</literal></link> role can call <command>CHECKPOINT</command>. </para> + + <para> + The checkpointer process running the checkpoint will report its progress + in the <structname>pg_stat_progress_checkpoint</structname> view except for + the shutdown and end-of-recovery cases. See + <xref linkend="checkpoint-progress-reporting"/> for details. + </para> </refsect1> <refsect1> diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index 4b6ef283c1..607f21dfd4 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -530,7 +530,11 @@ adjust the <xref linkend="guc-archive-timeout"/> parameter rather than the checkpoint parameters.) It is also possible to force a checkpoint by using the SQL - command <command>CHECKPOINT</command>. + command <command>CHECKPOINT</command>. The checkpointer process running the + checkpoint will report its progress in the + <structname>pg_stat_progress_checkpoint</structname> view except for the + shutdown and end-of-recovery cases. See + <xref linkend="checkpoint-progress-reporting"/> for details. </para> <para> diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 71136b11a2..8272d02b1e 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -66,6 +66,7 @@ #include "catalog/catversion.h" #include "catalog/pg_control.h" #include "catalog/pg_database.h" +#include "commands/progress.h" #include "common/controldata_utils.h" #include "common/file_utils.h" #include "executor/instrument.h" @@ -695,6 +696,8 @@ static void WALInsertLockAcquireExclusive(void); static void WALInsertLockRelease(void); static void WALInsertLockUpdateInsertingAt(XLogRecPtr insertingAt); +static void checkpoint_progress_start(int flags, int type); + /* * Insert an XLOG record represented by an already-constructed chain of data * chunks. This is a low-level routine; to construct the WAL record header @@ -6429,6 +6432,9 @@ CreateCheckPoint(int flags) XLogCtl->RedoRecPtr = checkPoint.redo; SpinLockRelease(&XLogCtl->info_lck); + /* Prepare to report progress of the checkpoint. */ + checkpoint_progress_start(flags, PROGRESS_CHECKPOINT_TYPE_CHECKPOINT); + /* * If enabled, log checkpoint start. We postpone this until now so as not * to log anything if we decided to skip the checkpoint. @@ -6511,6 +6517,8 @@ CreateCheckPoint(int flags) * clog and we will correctly flush the update below. So we cannot miss * any xacts we need to wait for. */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_GET_VIRTUAL_TRANSACTION_IDS); vxids = GetVirtualXIDsDelayingChkpt(&nvxids, DELAY_CHKPT_START); if (nvxids > 0) { @@ -6626,6 +6634,8 @@ CreateCheckPoint(int flags) /* * Let smgr do post-checkpoint cleanup (eg, deleting old files). */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_POST_CHECKPOINT_CLEANUP); SyncPostCheckpoint(); /* @@ -6641,6 +6651,9 @@ CreateCheckPoint(int flags) */ XLByteToSeg(RedoRecPtr, _logSegNo, wal_segment_size); KeepLogSeg(recptr, &_logSegNo); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS); + if (InvalidateObsoleteReplicationSlots(_logSegNo)) { /* @@ -6651,6 +6664,8 @@ CreateCheckPoint(int flags) KeepLogSeg(recptr, &_logSegNo); } _logSegNo--; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG); RemoveOldXlogFiles(_logSegNo, RedoRecPtr, recptr, checkPoint.ThisTimeLineID); @@ -6669,11 +6684,21 @@ CreateCheckPoint(int flags) * StartupSUBTRANS hasn't been called yet. */ if (!RecoveryInProgress()) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS); TruncateSUBTRANS(GetOldestTransactionIdConsideredRunning()); + } + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_FINALIZE); /* Real work is done; log and update stats. */ LogCheckpointEnd(false); + /* Stop reporting progress of the checkpoint. */ + pgstat_progress_end_command(); + /* Reset the process title */ update_checkpoint_display(flags, false, true); @@ -6830,29 +6855,63 @@ static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags) { CheckPointRelationMap(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_REPLI_SLOTS); CheckPointReplicationSlots(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SNAPSHOTS); CheckPointSnapBuild(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_LOGICAL_REWRITE_MAPPINGS); CheckPointLogicalRewriteHeap(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_REPLI_ORIGIN); CheckPointReplicationOrigin(); /* Write out all dirty data in SLRUs and the main buffer pool */ TRACE_POSTGRESQL_BUFFER_CHECKPOINT_START(flags); CheckpointStats.ckpt_write_t = GetCurrentTimestamp(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_CLOG_PAGES); CheckPointCLOG(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_COMMITTS_PAGES); CheckPointCommitTs(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SUBTRANS_PAGES); CheckPointSUBTRANS(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_MULTIXACT_PAGES); CheckPointMultiXact(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_PREDICATE_LOCK_PAGES); CheckPointPredicate(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_BUFFERS); CheckPointBuffers(flags); /* Perform all queued up fsyncs */ TRACE_POSTGRESQL_BUFFER_CHECKPOINT_SYNC_START(); CheckpointStats.ckpt_sync_t = GetCurrentTimestamp(); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SYNC_FILES); ProcessSyncRequests(); CheckpointStats.ckpt_sync_end_t = GetCurrentTimestamp(); TRACE_POSTGRESQL_BUFFER_CHECKPOINT_DONE(); /* We deliberately delay 2PC checkpointing as long as possible */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TWO_PHASE); CheckPointTwoPhase(checkPointRedo); } @@ -7002,6 +7061,9 @@ CreateRestartPoint(int flags) MemSet(&CheckpointStats, 0, sizeof(CheckpointStats)); CheckpointStats.ckpt_start_t = GetCurrentTimestamp(); + /* Prepare to report progress of the restartpoint. */ + checkpoint_progress_start(flags, PROGRESS_CHECKPOINT_TYPE_RESTARTPOINT); + if (log_checkpoints) LogCheckpointStart(flags, true); @@ -7085,6 +7147,9 @@ CreateRestartPoint(int flags) replayPtr = GetXLogReplayRecPtr(&replayTLI); endptr = (receivePtr < replayPtr) ? replayPtr : receivePtr; KeepLogSeg(endptr, &_logSegNo); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS); + if (InvalidateObsoleteReplicationSlots(_logSegNo)) { /* @@ -7111,6 +7176,8 @@ CreateRestartPoint(int flags) if (!RecoveryInProgress()) replayTLI = XLogCtl->InsertTimeLineID; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG); RemoveOldXlogFiles(_logSegNo, RedoRecPtr, endptr, replayTLI); /* @@ -7127,11 +7194,20 @@ CreateRestartPoint(int flags) * this because StartupSUBTRANS hasn't been called yet. */ if (EnableHotStandby) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS); TruncateSUBTRANS(GetOldestTransactionIdConsideredRunning()); + } + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_FINALIZE); /* Real work is done; log and update stats. */ LogCheckpointEnd(true); + /* Stop reporting progress of the restartpoint. */ + pgstat_progress_end_command(); + /* Reset the process title */ update_checkpoint_display(flags, true, true); @@ -8880,3 +8956,29 @@ SetWalWriterSleeping(bool sleeping) XLogCtl->WalWriterSleeping = sleeping; SpinLockRelease(&XLogCtl->info_lck); } + +/* + * Start reporting progress of the checkpoint. + */ +static void +checkpoint_progress_start(int flags, int type) +{ + const int index[] = { + PROGRESS_CHECKPOINT_TYPE, + PROGRESS_CHECKPOINT_FLAGS, + PROGRESS_CHECKPOINT_LSN, + PROGRESS_CHECKPOINT_START_TIMESTAMP, + PROGRESS_CHECKPOINT_PHASE + }; + int64 val[5]; + + pgstat_progress_start_command(PROGRESS_COMMAND_CHECKPOINT, InvalidOid); + + val[0] = type; + val[1] = flags; + val[2] = RedoRecPtr; + val[3] = CheckpointStats.ckpt_start_t; + val[4] = PROGRESS_CHECKPOINT_PHASE_INIT; + + pgstat_progress_update_multi_param(5, index, val); +} \ No newline at end of file diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index fedaed533b..20d029a547 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1265,6 +1265,57 @@ CREATE VIEW pg_stat_progress_copy AS FROM pg_stat_get_progress_info('COPY') AS S LEFT JOIN pg_database D ON S.datid = D.oid; +CREATE VIEW pg_stat_progress_checkpoint AS + SELECT + S.pid AS pid, + CASE S.param1 WHEN 1 THEN 'checkpoint' + WHEN 2 THEN 'restartpoint' + END AS type, + ( CASE WHEN (S.param2 & 4) > 0 THEN 'immediate ' ELSE '' END || + CASE WHEN (S.param2 & 8) > 0 THEN 'force ' ELSE '' END || + CASE WHEN (S.param2 & 16) > 0 THEN 'flush-all ' ELSE '' END || + CASE WHEN (S.param2 & 32) > 0 THEN 'wait ' ELSE '' END || + CASE WHEN (S.param2 & 128) > 0 THEN 'wal ' ELSE '' END || + CASE WHEN (S.param2 & 256) > 0 THEN 'time ' ELSE '' END + ) AS flags, + ( '0/0'::pg_lsn + + ((CASE + WHEN S.param3 < 0 THEN pow(2::numeric, 64::numeric)::numeric + ELSE 0::numeric + END) + + S.param3::numeric) + ) AS start_lsn, + to_timestamp(946684800 + (S.param4::float8 / 1000000)) AS start_time, + CASE S.param5 WHEN 1 THEN 'initializing' + WHEN 2 THEN 'getting virtual transaction IDs' + WHEN 3 THEN 'checkpointing replication slots' + WHEN 4 THEN 'checkpointing logical replication snapshot files' + WHEN 5 THEN 'checkpointing logical rewrite mapping files' + WHEN 6 THEN 'checkpointing replication origin' + WHEN 7 THEN 'checkpointing commit log pages' + WHEN 8 THEN 'checkpointing commit time stamp pages' + WHEN 9 THEN 'checkpointing subtransaction pages' + WHEN 10 THEN 'checkpointing multixact pages' + WHEN 11 THEN 'checkpointing predicate lock pages' + WHEN 12 THEN 'checkpointing buffers' + WHEN 13 THEN 'processing file sync requests' + WHEN 14 THEN 'performing two phase checkpoint' + WHEN 15 THEN 'performing post checkpoint cleanup' + WHEN 16 THEN 'invalidating replication slots' + WHEN 17 THEN 'recycling old WAL files' + WHEN 18 THEN 'truncating subtransactions' + WHEN 19 THEN 'finalizing' + END AS phase, + S.param6 AS buffers_total, + S.param7 AS buffers_processed, + S.param8 AS buffers_written, + S.param9 AS files_total, + S.param10 AS files_synced, + CASE S.param11 WHEN 0 THEN 'false' + WHEN 1 THEN 'true' + END AS new_requests + FROM pg_stat_get_progress_info('CHECKPOINT') AS S; + CREATE VIEW pg_user_mappings AS SELECT U.oid AS umid, diff --git a/src/backend/postmaster/checkpointer.c b/src/backend/postmaster/checkpointer.c index c937c39f50..79cae7e9ca 100644 --- a/src/backend/postmaster/checkpointer.c +++ b/src/backend/postmaster/checkpointer.c @@ -39,6 +39,7 @@ #include "access/xlog.h" #include "access/xlog_internal.h" #include "access/xlogrecovery.h" +#include "commands/progress.h" #include "libpq/pqsignal.h" #include "miscadmin.h" #include "pgstat.h" @@ -163,7 +164,7 @@ static pg_time_t last_xlog_switch_time; static void HandleCheckpointerInterrupts(void); static void CheckArchiveTimeout(void); static bool IsCheckpointOnSchedule(double progress); -static bool ImmediateCheckpointRequested(void); +static bool ImmediateCheckpointRequested(int flags); static bool CompactCheckpointerRequestQueue(void); static void UpdateSharedMemoryConfig(void); @@ -667,16 +668,24 @@ CheckArchiveTimeout(void) * there is one pending behind it.) */ static bool -ImmediateCheckpointRequested(void) +ImmediateCheckpointRequested(int flags) { volatile CheckpointerShmemStruct *cps = CheckpointerShmem; + if (cps->ckpt_flags & CHECKPOINT_REQUESTED) + pgstat_progress_update_param(PROGRESS_CHECKPOINT_NEW_REQUESTS, true); + /* * We don't need to acquire the ckpt_lck in this case because we're only * looking at a single flag bit. */ if (cps->ckpt_flags & CHECKPOINT_IMMEDIATE) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FLAGS, + (flags | CHECKPOINT_IMMEDIATE)); return true; + } + return false; } @@ -708,7 +717,7 @@ CheckpointWriteDelay(int flags, double progress) */ if (!(flags & CHECKPOINT_IMMEDIATE) && !ShutdownRequestPending && - !ImmediateCheckpointRequested() && + !ImmediateCheckpointRequested(flags) && IsCheckpointOnSchedule(progress)) { if (ConfigReloadPending) diff --git a/src/backend/storage/buffer/bufmgr.c b/src/backend/storage/buffer/bufmgr.c index ae13011d27..55f03c1301 100644 --- a/src/backend/storage/buffer/bufmgr.c +++ b/src/backend/storage/buffer/bufmgr.c @@ -39,6 +39,7 @@ #include "catalog/catalog.h" #include "catalog/storage.h" #include "catalog/storage_xlog.h" +#include "commands/progress.h" #include "executor/instrument.h" #include "lib/binaryheap.h" #include "miscadmin.h" @@ -2019,6 +2020,8 @@ BufferSync(int flags) WritebackContextInit(&wb_context, &checkpoint_flush_after); TRACE_POSTGRESQL_BUFFER_SYNC_START(NBuffers, num_to_scan); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_TOTAL, + num_to_scan); /* * Sort buffers that need to be written to reduce the likelihood of random @@ -2136,6 +2139,8 @@ BufferSync(int flags) bufHdr = GetBufferDescriptor(buf_id); num_processed++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_PROCESSED, + num_processed); /* * We don't need to acquire the lock here, because we're only looking @@ -2156,6 +2161,8 @@ BufferSync(int flags) TRACE_POSTGRESQL_BUFFER_SYNC_WRITTEN(buf_id); PendingCheckpointerStats.buf_written_checkpoints++; num_written++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_WRITTEN, + num_written); } } diff --git a/src/backend/storage/sync/sync.c b/src/backend/storage/sync/sync.c index e1fb631003..3acbf94c5e 100644 --- a/src/backend/storage/sync/sync.c +++ b/src/backend/storage/sync/sync.c @@ -23,6 +23,7 @@ #include "access/multixact.h" #include "access/xlog.h" #include "access/xlogutils.h" +#include "commands/progress.h" #include "commands/tablespace.h" #include "miscadmin.h" #include "pgstat.h" @@ -368,6 +369,9 @@ ProcessSyncRequests(void) /* Now scan the hashtable for fsync requests to process */ absorb_counter = FSYNCS_PER_ABSORB; hash_seq_init(&hstat, pendingOps); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FILES_TOTAL, + hash_get_num_entries(pendingOps)); + while ((entry = (PendingFsyncEntry *) hash_seq_search(&hstat)) != NULL) { int failures; @@ -431,6 +435,8 @@ ProcessSyncRequests(void) longest = elapsed; total_elapsed += elapsed; processed++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FILES_SYNCED, + processed); if (log_checkpoints) elog(DEBUG1, "checkpoint sync: number=%d file=%s time=%.3f ms", diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c index 893690dad5..c0de766fde 100644 --- a/src/backend/utils/adt/pgstatfuncs.c +++ b/src/backend/utils/adt/pgstatfuncs.c @@ -476,6 +476,8 @@ pg_stat_get_progress_info(PG_FUNCTION_ARGS) cmdtype = PROGRESS_COMMAND_BASEBACKUP; else if (pg_strcasecmp(cmd, "COPY") == 0) cmdtype = PROGRESS_COMMAND_COPY; + else if (pg_strcasecmp(cmd, "CHECKPOINT") == 0) + cmdtype = PROGRESS_COMMAND_CHECKPOINT; else ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), diff --git a/src/include/commands/progress.h b/src/include/commands/progress.h index a28938caf4..33a64d2f0b 100644 --- a/src/include/commands/progress.h +++ b/src/include/commands/progress.h @@ -151,4 +151,42 @@ #define PROGRESS_COPY_TYPE_PIPE 3 #define PROGRESS_COPY_TYPE_CALLBACK 4 +/* Progress parameters for checkpoint */ +#define PROGRESS_CHECKPOINT_TYPE 0 +#define PROGRESS_CHECKPOINT_FLAGS 1 +#define PROGRESS_CHECKPOINT_LSN 2 +#define PROGRESS_CHECKPOINT_START_TIMESTAMP 3 +#define PROGRESS_CHECKPOINT_PHASE 4 +#define PROGRESS_CHECKPOINT_BUFFERS_TOTAL 5 +#define PROGRESS_CHECKPOINT_BUFFERS_PROCESSED 6 +#define PROGRESS_CHECKPOINT_BUFFERS_WRITTEN 7 +#define PROGRESS_CHECKPOINT_FILES_TOTAL 8 +#define PROGRESS_CHECKPOINT_FILES_SYNCED 9 +#define PROGRESS_CHECKPOINT_NEW_REQUESTS 10 + +/* Types of checkpoint (as advertised via PROGRESS_CHECKPOINT_TYPE) */ +#define PROGRESS_CHECKPOINT_TYPE_CHECKPOINT 1 +#define PROGRESS_CHECKPOINT_TYPE_RESTARTPOINT 2 + +/* Phases of checkpoint (as advertised via PROGRESS_CHECKPOINT_PHASE) */ +#define PROGRESS_CHECKPOINT_PHASE_INIT 1 +#define PROGRESS_CHECKPOINT_PHASE_GET_VIRTUAL_TRANSACTION_IDS 2 +#define PROGRESS_CHECKPOINT_PHASE_REPLI_SLOTS 3 +#define PROGRESS_CHECKPOINT_PHASE_SNAPSHOTS 4 +#define PROGRESS_CHECKPOINT_PHASE_LOGICAL_REWRITE_MAPPINGS 5 +#define PROGRESS_CHECKPOINT_PHASE_REPLI_ORIGIN 6 +#define PROGRESS_CHECKPOINT_PHASE_CLOG_PAGES 7 +#define PROGRESS_CHECKPOINT_PHASE_COMMITTS_PAGES 8 +#define PROGRESS_CHECKPOINT_PHASE_SUBTRANS_PAGES 9 +#define PROGRESS_CHECKPOINT_PHASE_MULTIXACT_PAGES 10 +#define PROGRESS_CHECKPOINT_PHASE_PREDICATE_LOCK_PAGES 11 +#define PROGRESS_CHECKPOINT_PHASE_BUFFERS 12 +#define PROGRESS_CHECKPOINT_PHASE_SYNC_FILES 13 +#define PROGRESS_CHECKPOINT_PHASE_TWO_PHASE 14 +#define PROGRESS_CHECKPOINT_PHASE_POST_CHECKPOINT_CLEANUP 15 +#define PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS 16 +#define PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG 17 +#define PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS 18 +#define PROGRESS_CHECKPOINT_PHASE_FINALIZE 19 + #endif diff --git a/src/include/utils/backend_progress.h b/src/include/utils/backend_progress.h index 47bf8029b0..02d51fb948 100644 --- a/src/include/utils/backend_progress.h +++ b/src/include/utils/backend_progress.h @@ -27,7 +27,8 @@ typedef enum ProgressCommandType PROGRESS_COMMAND_CLUSTER, PROGRESS_COMMAND_CREATE_INDEX, PROGRESS_COMMAND_BASEBACKUP, - PROGRESS_COMMAND_COPY + PROGRESS_COMMAND_COPY, + PROGRESS_COMMAND_CHECKPOINT } ProgressCommandType; #define PGSTAT_NUM_PROGRESS_PARAM 20 diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index fc3cde3226..ec130dad2a 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1912,6 +1912,76 @@ pg_stat_progress_basebackup| SELECT s.pid, s.param4 AS tablespaces_total, s.param5 AS tablespaces_streamed FROM pg_stat_get_progress_info('BASEBACKUP'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); +pg_stat_progress_checkpoint| SELECT s.pid, + CASE s.param1 + WHEN 1 THEN 'checkpoint'::text + WHEN 2 THEN 'restartpoint'::text + ELSE NULL::text + END AS type, + ((((( + CASE + WHEN ((s.param2 & (4)::bigint) > 0) THEN 'immediate '::text + ELSE ''::text + END || + CASE + WHEN ((s.param2 & (8)::bigint) > 0) THEN 'force '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (16)::bigint) > 0) THEN 'flush-all '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (32)::bigint) > 0) THEN 'wait '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (128)::bigint) > 0) THEN 'wal '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (256)::bigint) > 0) THEN 'time '::text + ELSE ''::text + END) AS flags, + ('0/0'::pg_lsn + ( + CASE + WHEN (s.param3 < 0) THEN pow((2)::numeric, (64)::numeric) + ELSE (0)::numeric + END + (s.param3)::numeric)) AS start_lsn, + to_timestamp(((946684800)::double precision + ((s.param4)::double precision / (1000000)::double precision))) AS start_time, + CASE s.param5 + WHEN 1 THEN 'initializing'::text + WHEN 2 THEN 'getting virtual transaction IDs'::text + WHEN 3 THEN 'checkpointing replication slots'::text + WHEN 4 THEN 'checkpointing logical replication snapshot files'::text + WHEN 5 THEN 'checkpointing logical rewrite mapping files'::text + WHEN 6 THEN 'checkpointing replication origin'::text + WHEN 7 THEN 'checkpointing commit log pages'::text + WHEN 8 THEN 'checkpointing commit time stamp pages'::text + WHEN 9 THEN 'checkpointing subtransaction pages'::text + WHEN 10 THEN 'checkpointing multixact pages'::text + WHEN 11 THEN 'checkpointing predicate lock pages'::text + WHEN 12 THEN 'checkpointing buffers'::text + WHEN 13 THEN 'processing file sync requests'::text + WHEN 14 THEN 'performing two phase checkpoint'::text + WHEN 15 THEN 'performing post checkpoint cleanup'::text + WHEN 16 THEN 'invalidating replication slots'::text + WHEN 17 THEN 'recycling old WAL files'::text + WHEN 18 THEN 'truncating subtransactions'::text + WHEN 19 THEN 'finalizing'::text + ELSE NULL::text + END AS phase, + s.param6 AS buffers_total, + s.param7 AS buffers_processed, + s.param8 AS buffers_written, + s.param9 AS files_total, + s.param10 AS files_synced, + CASE s.param11 + WHEN 0 THEN 'false'::text + WHEN 1 THEN 'true'::text + ELSE NULL::text + END AS new_requests + FROM pg_stat_get_progress_info('CHECKPOINT'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); pg_stat_progress_cluster| SELECT s.pid, s.datid, d.datname, -- 2.25.1 ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-06-13 13:38 Nitin Jadhav <[email protected]> 2 siblings, 1 reply; 32+ messages in thread From: Nitin Jadhav @ 2022-06-13 13:38 UTC (permalink / raw) To: Andres Freund <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> > Have you measured the performance effects of this? On fast storage with large > shared_buffers I've seen these loops in profiles. It's probably fine, but it'd > be good to verify that. To understand the performance effects of the above, I have taken the average of five checkpoints with the patch and without the patch in my environment. Here are the results. With patch: 269.65 s Without patch: 269.60 s It looks fine. Please share your views. > This view is depressingly complicated. Added up the view definitions for > the already existing pg_stat_progress* views add up to a measurable part of > the size of an empty database: Thank you so much for sharing the detailed analysis. We can remove a few fields which are not so important to make it simple. Thanks & Regards, Nitin Jadhav On Sat, Mar 19, 2022 at 5:45 AM Andres Freund <[email protected]> wrote: > > Hi, > > This is a long thread, sorry for asking if this has been asked before. > > On 2022-03-08 20:25:28 +0530, Nitin Jadhav wrote: > > * Sort buffers that need to be written to reduce the likelihood of random > > @@ -2129,6 +2132,8 @@ BufferSync(int flags) > > bufHdr = GetBufferDescriptor(buf_id); > > > > num_processed++; > > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_PROCESSED, > > + num_processed); > > > > /* > > * We don't need to acquire the lock here, because we're only looking > > @@ -2149,6 +2154,8 @@ BufferSync(int flags) > > TRACE_POSTGRESQL_BUFFER_SYNC_WRITTEN(buf_id); > > PendingCheckpointerStats.m_buf_written_checkpoints++; > > num_written++; > > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_WRITTEN, > > + num_written); > > } > > } > > Have you measured the performance effects of this? On fast storage with large > shared_buffers I've seen these loops in profiles. It's probably fine, but it'd > be good to verify that. > > > > @@ -1897,6 +1897,112 @@ pg_stat_progress_basebackup| SELECT s.pid, > > s.param4 AS tablespaces_total, > > s.param5 AS tablespaces_streamed > > FROM pg_stat_get_progress_info('BASEBACKUP'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); > > +pg_stat_progress_checkpoint| SELECT s.pid, > > + CASE s.param1 > > + WHEN 1 THEN 'checkpoint'::text > > + WHEN 2 THEN 'restartpoint'::text > > + ELSE NULL::text > > + END AS type, > > + ((((((( > > + CASE > > + WHEN ((s.param2 & (1)::bigint) > 0) THEN 'shutdown '::text > > + ELSE ''::text > > + END || > > + CASE > > + WHEN ((s.param2 & (2)::bigint) > 0) THEN 'end-of-recovery '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param2 & (4)::bigint) > 0) THEN 'immediate '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param2 & (8)::bigint) > 0) THEN 'force '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param2 & (16)::bigint) > 0) THEN 'flush-all '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param2 & (32)::bigint) > 0) THEN 'wait '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param2 & (128)::bigint) > 0) THEN 'wal '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param2 & (256)::bigint) > 0) THEN 'time '::text > > + ELSE ''::text > > + END) AS flags, > > + ((((((( > > + CASE > > + WHEN ((s.param3 & (1)::bigint) > 0) THEN 'shutdown '::text > > + ELSE ''::text > > + END || > > + CASE > > + WHEN ((s.param3 & (2)::bigint) > 0) THEN 'end-of-recovery '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param3 & (4)::bigint) > 0) THEN 'immediate '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param3 & (8)::bigint) > 0) THEN 'force '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param3 & (16)::bigint) > 0) THEN 'flush-all '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param3 & (32)::bigint) > 0) THEN 'wait '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param3 & (128)::bigint) > 0) THEN 'wal '::text > > + ELSE ''::text > > + END) || > > + CASE > > + WHEN ((s.param3 & (256)::bigint) > 0) THEN 'time '::text > > + ELSE ''::text > > + END) AS next_flags, > > + ('0/0'::pg_lsn + ( > > + CASE > > + WHEN (s.param4 < 0) THEN pow((2)::numeric, (64)::numeric) > > + ELSE (0)::numeric > > + END + (s.param4)::numeric)) AS start_lsn, > > + to_timestamp(((946684800)::double precision + ((s.param5)::double precision / (1000000)::double precision))) AS start_time, > > + CASE s.param6 > > + WHEN 1 THEN 'initializing'::text > > + WHEN 2 THEN 'getting virtual transaction IDs'::text > > + WHEN 3 THEN 'checkpointing replication slots'::text > > + WHEN 4 THEN 'checkpointing logical replication snapshot files'::text > > + WHEN 5 THEN 'checkpointing logical rewrite mapping files'::text > > + WHEN 6 THEN 'checkpointing replication origin'::text > > + WHEN 7 THEN 'checkpointing commit log pages'::text > > + WHEN 8 THEN 'checkpointing commit time stamp pages'::text > > + WHEN 9 THEN 'checkpointing subtransaction pages'::text > > + WHEN 10 THEN 'checkpointing multixact pages'::text > > + WHEN 11 THEN 'checkpointing predicate lock pages'::text > > + WHEN 12 THEN 'checkpointing buffers'::text > > + WHEN 13 THEN 'processing file sync requests'::text > > + WHEN 14 THEN 'performing two phase checkpoint'::text > > + WHEN 15 THEN 'performing post checkpoint cleanup'::text > > + WHEN 16 THEN 'invalidating replication slots'::text > > + WHEN 17 THEN 'recycling old WAL files'::text > > + WHEN 18 THEN 'truncating subtransactions'::text > > + WHEN 19 THEN 'finalizing'::text > > + ELSE NULL::text > > + END AS phase, > > + s.param7 AS buffers_total, > > + s.param8 AS buffers_processed, > > + s.param9 AS buffers_written, > > + s.param10 AS files_total, > > + s.param11 AS files_synced > > + FROM pg_stat_get_progress_info('CHECKPOINT'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); > > pg_stat_progress_cluster| SELECT s.pid, > > s.datid, > > d.datname, > > This view is depressingly complicated. Added up the view definitions for > the already existing pg_stat_progress* views add up to a measurable part of > the size of an empty database: > > postgres[1160866][1]=# SELECT sum(octet_length(ev_action)), SUM(pg_column_size(ev_action)) FROM pg_rewrite WHERE ev_class::regclass::text LIKE '%progress%'; > ┌───────┬───────┐ > │ sum │ sum │ > ├───────┼───────┤ > │ 97410 │ 19786 │ > └───────┴───────┘ > (1 row) > > and this view looks to be a good bit more complicated than the existing > pg_stat_progress* views. > > Indeed: > template1[1165473][1]=# SELECT ev_class::regclass, length(ev_action), pg_column_size(ev_action) FROM pg_rewrite WHERE ev_class::regclass::text LIKE '%progress%' ORDER BY length(ev_action) DESC; > ┌───────────────────────────────┬────────┬────────────────┐ > │ ev_class │ length │ pg_column_size │ > ├───────────────────────────────┼────────┼────────────────┤ > │ pg_stat_progress_checkpoint │ 43290 │ 5409 │ > │ pg_stat_progress_create_index │ 23293 │ 4177 │ > │ pg_stat_progress_cluster │ 18390 │ 3704 │ > │ pg_stat_progress_analyze │ 16121 │ 3339 │ > │ pg_stat_progress_vacuum │ 16076 │ 3392 │ > │ pg_stat_progress_copy │ 15124 │ 3080 │ > │ pg_stat_progress_basebackup │ 8406 │ 2094 │ > └───────────────────────────────┴────────┴────────────────┘ > (7 rows) > > pg_rewrite without pg_stat_progress_checkpoint: 745472, with: 753664 > > > pg_rewrite is the second biggest relation in an empty database already... > > template1[1164827][1]=# SELECT relname, pg_total_relation_size(oid) FROM pg_class WHERE relkind = 'r' ORDER BY 2 DESC LIMIT 5; > ┌────────────────┬────────────────────────┐ > │ relname │ pg_total_relation_size │ > ├────────────────┼────────────────────────┤ > │ pg_proc │ 1212416 │ > │ pg_rewrite │ 745472 │ > │ pg_attribute │ 704512 │ > │ pg_description │ 630784 │ > │ pg_collation │ 409600 │ > └────────────────┴────────────────────────┘ > (5 rows) > > Greetings, > > Andres Freund ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-06-13 13:56 Nitin Jadhav <[email protected]> parent: Michael Paquier <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Nitin Jadhav @ 2022-06-13 13:56 UTC (permalink / raw) To: Michael Paquier <[email protected]>; +Cc: Andres Freund <[email protected]>; Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> > > Have you measured the performance effects of this? On fast storage with large > > shared_buffers I've seen these loops in profiles. It's probably fine, but it'd > > be good to verify that. > > I am wondering if we could make the function inlined at some point. > We could also play it safe and only update the counters every N loops > instead. The idea looks good but based on the performance numbers shared above, it is not affecting the performance. So we can use the current approach as it gives more accurate progress. --- > > This view is depressingly complicated. Added up the view definitions for > > the already existing pg_stat_progress* views add up to a measurable part of > > the size of an empty database: > > Yeah. I think that what's proposed could be simplified, and we had > better remove the fields that are not that useful. First, do we have > any need for next_flags? "next_flags" is removed in the v6 patch. Added a "new_requests" field to get to know whether the current checkpoint is being throttled or not. Please share your views on this. --- > Second, is the start LSN really necessary > for monitoring purposes? IMO, start LSN is necessary to debug if the checkpoint is taking longer. --- > Not all the information in the first > parameter is useful, as well. For example "shutdown" will never be > seen as it is not possible to use a session at this stage, no? I understand that "shutdown" and "end-of-recovery" will never be seen and I have removed it in the v6 patch. --- > There > is also no gain in having "immediate", "flush-all", "force" and "wait" > (for this one if the checkpoint is requested the session doing the > work knows this information already). "immediate" is required to understand whether the current checkpoint is throttled or not. I am not sure about other flags "flush-all", "force" and "wait". I have just supported all the flags to match the 'checkpoint start' log message. Please share your views. If it is not really required, I will remove it in the next patch. --- > A last thing is that we may gain in visibility by having more > attributes as an effect of splitting param2. On thing that would make > sense is to track the reason why the checkpoint was triggered > separately (aka wal and time). Should we use a text[] instead to list > all the parameters instead? Using a space-separated list of items is > not intuitive IMO, and callers of this routine will likely parse > that. If I understand the above comment correctly, you are saying to introduce a new field, say "reason" ( possible values are either wal or time) and the "flags" field will continue to represent the other flags like "immediate", etc. The idea looks good here. We can introduce new field "reason" and "flags" field can be renamed to "throttled" (true/false) if we decide to not support other flags "flush-all", "force" and "wait". --- > + WHEN 3 THEN 'checkpointing replication slots' > + WHEN 4 THEN 'checkpointing logical replication snapshot files' > + WHEN 5 THEN 'checkpointing logical rewrite mapping files' > + WHEN 6 THEN 'checkpointing replication origin' > + WHEN 7 THEN 'checkpointing commit log pages' > + WHEN 8 THEN 'checkpointing commit time stamp pages' > There is a lot of "checkpointing" here. All those terms could be > shorter without losing their meaning. I will try to make it short in the next patch. --- Please share your thoughts. Thanks & Regards, Nitin Jadhav On Tue, Apr 5, 2022 at 3:15 PM Michael Paquier <[email protected]> wrote: > > On Fri, Mar 18, 2022 at 05:15:56PM -0700, Andres Freund wrote: > > Have you measured the performance effects of this? On fast storage with large > > shared_buffers I've seen these loops in profiles. It's probably fine, but it'd > > be good to verify that. > > I am wondering if we could make the function inlined at some point. > We could also play it safe and only update the counters every N loops > instead. > > > This view is depressingly complicated. Added up the view definitions for > > the already existing pg_stat_progress* views add up to a measurable part of > > the size of an empty database: > > Yeah. I think that what's proposed could be simplified, and we had > better remove the fields that are not that useful. First, do we have > any need for next_flags? Second, is the start LSN really necessary > for monitoring purposes? Not all the information in the first > parameter is useful, as well. For example "shutdown" will never be > seen as it is not possible to use a session at this stage, no? There > is also no gain in having "immediate", "flush-all", "force" and "wait" > (for this one if the checkpoint is requested the session doing the > work knows this information already). > > A last thing is that we may gain in visibility by having more > attributes as an effect of splitting param2. On thing that would make > sense is to track the reason why the checkpoint was triggered > separately (aka wal and time). Should we use a text[] instead to list > all the parameters instead? Using a space-separated list of items is > not intuitive IMO, and callers of this routine will likely parse > that. > > Shouldn't we also track the number of files flushed in each sub-step? > In some deployments you could have a large number of 2PC files and > such. We may want more information on such matters. > > + WHEN 3 THEN 'checkpointing replication slots' > + WHEN 4 THEN 'checkpointing logical replication snapshot files' > + WHEN 5 THEN 'checkpointing logical rewrite mapping files' > + WHEN 6 THEN 'checkpointing replication origin' > + WHEN 7 THEN 'checkpointing commit log pages' > + WHEN 8 THEN 'checkpointing commit time stamp pages' > There is a lot of "checkpointing" here. All those terms could be > shorter without losing their meaning. > > This patch still needs some work, so I am marking it as RwF for now. > -- > Michael ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-07-07 00:04 Andres Freund <[email protected]> parent: Nitin Jadhav <[email protected]> 0 siblings, 1 reply; 32+ messages in thread From: Andres Freund @ 2022-07-07 00:04 UTC (permalink / raw) To: Nitin Jadhav <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On 2022-06-13 19:08:35 +0530, Nitin Jadhav wrote: > > Have you measured the performance effects of this? On fast storage with large > > shared_buffers I've seen these loops in profiles. It's probably fine, but it'd > > be good to verify that. > > To understand the performance effects of the above, I have taken the > average of five checkpoints with the patch and without the patch in my > environment. Here are the results. > With patch: 269.65 s > Without patch: 269.60 s Those look like timed checkpoints - if the checkpoints are sleeping a part of the time, you're not going to see any potential overhead. To see whether this has an effect you'd have to make sure there's a certain number of dirty buffers (e.g. by doing CREATE TABLE AS some_query) and then do a manual checkpoint and time how long that times. Greetings, Andres Freund ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-07-28 09:38 Nitin Jadhav <[email protected]> parent: Andres Freund <[email protected]> 0 siblings, 1 reply; 32+ messages in thread From: Nitin Jadhav @ 2022-07-28 09:38 UTC (permalink / raw) To: Andres Freund <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> > > To understand the performance effects of the above, I have taken the > > average of five checkpoints with the patch and without the patch in my > > environment. Here are the results. > > With patch: 269.65 s > > Without patch: 269.60 s > > Those look like timed checkpoints - if the checkpoints are sleeping a > part of the time, you're not going to see any potential overhead. Yes. The above data is collected from timed checkpoints. create table t1(a int); insert into t1 select * from generate_series(1,10000000); I generated a lot of data by using the above queries which would in turn trigger the checkpoint (wal). --- > To see whether this has an effect you'd have to make sure there's a > certain number of dirty buffers (e.g. by doing CREATE TABLE AS > some_query) and then do a manual checkpoint and time how long that > times. For this case I have generated data by using below queries. create table t1(a int); insert into t1 select * from generate_series(1,8000000); This does not trigger the checkpoint automatically. I have issued the CHECKPOINT manually and measured the performance by considering an average of 5 checkpoints. Here are the details. With patch: 2.457 s Without patch: 2.334 s Please share your thoughts. Thanks & Regards, Nitin Jadhav On Thu, Jul 7, 2022 at 5:34 AM Andres Freund <[email protected]> wrote: > > Hi, > > On 2022-06-13 19:08:35 +0530, Nitin Jadhav wrote: > > > Have you measured the performance effects of this? On fast storage with large > > > shared_buffers I've seen these loops in profiles. It's probably fine, but it'd > > > be good to verify that. > > > > To understand the performance effects of the above, I have taken the > > average of five checkpoints with the patch and without the patch in my > > environment. Here are the results. > > With patch: 269.65 s > > Without patch: 269.60 s > > Those look like timed checkpoints - if the checkpoints are sleeping a > part of the time, you're not going to see any potential overhead. > > To see whether this has an effect you'd have to make sure there's a > certain number of dirty buffers (e.g. by doing CREATE TABLE AS > some_query) and then do a manual checkpoint and time how long that > times. > > Greetings, > > Andres Freund ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-04 08:25 Drouvot, Bertrand <[email protected]> parent: Nitin Jadhav <[email protected]> 0 siblings, 4 replies; 32+ messages in thread From: Drouvot, Bertrand @ 2022-11-04 08:25 UTC (permalink / raw) To: Nitin Jadhav <[email protected]>; Andres Freund <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On 7/28/22 11:38 AM, Nitin Jadhav wrote: >>> To understand the performance effects of the above, I have taken the >>> average of five checkpoints with the patch and without the patch in my >>> environment. Here are the results. >>> With patch: 269.65 s >>> Without patch: 269.60 s >> >> Those look like timed checkpoints - if the checkpoints are sleeping a >> part of the time, you're not going to see any potential overhead. > > Yes. The above data is collected from timed checkpoints. > > create table t1(a int); > insert into t1 select * from generate_series(1,10000000); > > I generated a lot of data by using the above queries which would in > turn trigger the checkpoint (wal). > --- > >> To see whether this has an effect you'd have to make sure there's a >> certain number of dirty buffers (e.g. by doing CREATE TABLE AS >> some_query) and then do a manual checkpoint and time how long that >> times. > > For this case I have generated data by using below queries. > > create table t1(a int); > insert into t1 select * from generate_series(1,8000000); > > This does not trigger the checkpoint automatically. I have issued the > CHECKPOINT manually and measured the performance by considering an > average of 5 checkpoints. Here are the details. > > With patch: 2.457 s > Without patch: 2.334 s > > Please share your thoughts. > v6 was not applying anymore, due to a change in doc/src/sgml/ref/checkpoint.sgml done by b9eb0ff09e (Rename pg_checkpointer predefined role to pg_checkpoint). Please find attached a rebase in v7. While working on this rebase, I also noticed that "pg_checkpointer" is still mentioned in some translation files: " $ git grep pg_checkpointer src/backend/po/de.po:msgid "must be superuser or have privileges of pg_checkpointer to do CHECKPOINT" src/backend/po/ja.po:msgid "must be superuser or have privileges of pg_checkpointer to do CHECKPOINT" src/backend/po/ja.po:msgstr "CHECKPOINTを実行するにはスーパーユーザーであるか、またはpg_checkpointerの権限を持つ必要があります" src/backend/po/sv.po:msgid "must be superuser or have privileges of pg_checkpointer to do CHECKPOINT" " I'm not familiar with how the translation files are handled (looks like they have their own set of commits, see 3c0bcdbc66 for example) but wanted to mention that "pg_checkpointer" is still mentioned (even if that may be expected as the last commit related to translation files (aka 3c0bcdbc66) is older than the one that renamed pg_checkpointer to pg_checkpoint (aka b9eb0ff09e)). That said, back to this patch: I did not look closely but noticed that the buffers_total reported by pg_stat_progress_checkpoint: postgres=# select type,flags,start_lsn,phase,buffers_total,new_requests from pg_stat_progress_checkpoint; type | flags | start_lsn | phase | buffers_total | new_requests ------------+-----------------------+------------+-----------------------+---------------+-------------- checkpoint | immediate force wait | 1/E6C523A8 | checkpointing buffers | 1024275 | false (1 row) is a little bit different from what is logged once completed: 2022-11-04 08:18:50.806 UTC [3488442] LOG: checkpoint complete: wrote 1024278 buffers (97.7%); Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com commit 5198f5010be0febd019b1888817e2d78b8e42b21 Author: bdrouvot <[email protected]> Date: Thu Nov 3 12:59:10 2022 +0000 v7-0001-pg_stat_progress_checkpoint-view.patch diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index e5d622d514..ceb7d60ffa 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -414,6 +414,13 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser See <xref linkend='copy-progress-reporting'/>. </entry> </row> + + <row> + <entry><structname>pg_stat_progress_checkpoint</structname><indexterm><primary>pg_stat_progress_checkpoint</primary></indexterm></entry> + <entry>One row only, showing the progress of the checkpoint. + See <xref linkend='checkpoint-progress-reporting'/>. + </entry> + </row> </tbody> </tgroup> </table> @@ -5784,7 +5791,7 @@ FROM pg_stat_get_backend_idset() AS backendid; which support progress reporting are <command>ANALYZE</command>, <command>CLUSTER</command>, <command>CREATE INDEX</command>, <command>VACUUM</command>, - <command>COPY</command>, + <command>COPY</command>, <command>CHECKPOINT</command> and <xref linkend="protocol-replication-base-backup"/> (i.e., replication command that <xref linkend="app-pgbasebackup"/> issues to take a base backup). @@ -7072,6 +7079,402 @@ FROM pg_stat_get_backend_idset() AS backendid; </table> </sect2> + <sect2 id="checkpoint-progress-reporting"> + <title>Checkpoint Progress Reporting</title> + + <indexterm> + <primary>pg_stat_progress_checkpoint</primary> + </indexterm> + + <para> + Whenever the checkpoint operation is running, the + <structname>pg_stat_progress_checkpoint</structname> view will contain a + single row indicating the progress of the checkpoint. The tables below + describe the information that will be reported and provide information about + how to interpret it. + </para> + + <table id="pg-stat-progress-checkpoint-view" xreflabel="pg_stat_progress_checkpoint"> + <title><structname>pg_stat_progress_checkpoint</structname> View</title> + <tgroup cols="1"> + <thead> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + Column Type + </para> + <para> + Description + </para></entry> + </row> + </thead> + + <tbody> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>pid</structfield> <type>integer</type> + </para> + <para> + Process ID of the checkpointer process. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>type</structfield> <type>text</type> + </para> + <para> + Type of the checkpoint. See <xref linkend="checkpoint-types"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>flags</structfield> <type>text</type> + </para> + <para> + Flags of the checkpoint. See <xref linkend="checkpoint-flags"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>start_lsn</structfield> <type>text</type> + </para> + <para> + The checkpoint start location. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>start_time</structfield> <type>timestamp with time zone</type> + </para> + <para> + Start time of the checkpoint. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>phase</structfield> <type>text</type> + </para> + <para> + Current processing phase. See <xref linkend="checkpoint-phases"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_total</structfield> <type>bigint</type> + </para> + <para> + Total number of buffers to be written. This is estimated and reported + as of the beginning of buffer write operation. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_processed</structfield> <type>bigint</type> + </para> + <para> + Number of buffers processed. This counter increases when the targeted + buffer is processed. This number will eventually become equal to + <literal>buffers_total</literal> when the checkpoint is + complete. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_written</structfield> <type>bigint</type> + </para> + <para> + Number of buffers written. This counter only advances when the targeted + buffers is written. Note that some of the buffers are processed but may + not required to be written. So this count will always be less than or + equal to <literal>buffers_total</literal>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>files_total</structfield> <type>bigint</type> + </para> + <para> + Total number of files to be synced. This is estimated and reported as of + the beginning of sync operation. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>files_synced</structfield> <type>bigint</type> + </para> + <para> + Number of files synced. This counter advances when the targeted file is + synced. This number will eventually become equal to + <literal>files_total</literal> when the checkpoint is complete. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>new_requests</structfield> <type>text</type> + </para> + <para> + True if any of the backend is requested for a checkpoint while the + current checkpoint is in progress, False otherwise. + </para></entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-types"> + <title>Checkpoint Types</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Types</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>checkpoint</literal></entry> + <entry> + The current operation is checkpoint. + </entry> + </row> + <row> + <entry><literal>restartpoint</literal></entry> + <entry> + The current operation is restartpoint. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-flags"> + <title>Checkpoint Flags</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Flags</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>shutdown</literal></entry> + <entry> + The checkpoint is for shutdown. + </entry> + </row> + <row> + <entry><literal>end-of-recovery</literal></entry> + <entry> + The checkpoint is for end-of-recovery. + </entry> + </row> + <row> + <entry><literal>immediate</literal></entry> + <entry> + The checkpoint happens without delays. + </entry> + </row> + <row> + <entry><literal>force</literal></entry> + <entry> + The checkpoint is started because some operation (for which the + checkpoint is necessary) forced a checkpoint. + </entry> + </row> + <row> + <entry><literal>flush all</literal></entry> + <entry> + The checkpoint flushes all pages, including those belonging to unlogged + tables. + </entry> + </row> + <row> + <entry><literal>wait</literal></entry> + <entry> + The operations which requested the checkpoint waits for completion + before returning. + </entry> + </row> + <row> + <entry><literal>requested</literal></entry> + <entry> + The checkpoint request has been made. + </entry> + </row> + <row> + <entry><literal>wal</literal></entry> + <entry> + The checkpoint is started because <literal>max_wal_size</literal> is + reached. + </entry> + </row> + <row> + <entry><literal>time</literal></entry> + <entry> + The checkpoint is started because <literal>checkpoint_timeout</literal> + expired. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-phases"> + <title>Checkpoint Phases</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Phase</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>initializing</literal></entry> + <entry> + The checkpointer process is preparing to begin the checkpoint operation. + This phase is expected to be very brief. + </entry> + </row> + <row> + <entry><literal>getting virtual transaction IDs</literal></entry> + <entry> + The checkpointer process is getting the virtual transaction IDs that + are delaying the checkpoint. + </entry> + </row> + <row> + <entry><literal>checkpointing replication slots</literal></entry> + <entry> + The checkpointer process is currently flushing all the replication slots + to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing logical replication snapshot files</literal></entry> + <entry> + The checkpointer process is currently removing all the serialized + snapshot files that are not required anymore. + </entry> + </row> + <row> + <entry><literal>checkpointing logical rewrite mapping files</literal></entry> + <entry> + The checkpointer process is currently removing unwanted or flushing + required logical rewrite mapping files. + </entry> + </row> + <row> + <entry><literal>checkpointing replication origin</literal></entry> + <entry> + The checkpointer process is currently performing a checkpoint of each + replication origin's progress with respect to the replayed remote LSN. + </entry> + </row> + <row> + <entry><literal>checkpointing commit log pages</literal></entry> + <entry> + The checkpointer process is currently writing commit log pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing commit time stamp pages</literal></entry> + <entry> + The checkpointer process is currently writing commit time stamp pages to + disk. + </entry> + </row> + <row> + <entry><literal>checkpointing subtransaction pages</literal></entry> + <entry> + The checkpointer process is currently writing subtransaction pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing multixact pages</literal></entry> + <entry> + The checkpointer process is currently writing multixact pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing predicate lock pages</literal></entry> + <entry> + The checkpointer process is currently writing predicate lock pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing buffers</literal></entry> + <entry> + The checkpointer process is currently writing buffers to disk. + </entry> + </row> + <row> + <entry><literal>processing file sync requests</literal></entry> + <entry> + The checkpointer process is currently processing file sync requests. + </entry> + </row> + <row> + <entry><literal>performing two phase checkpoint</literal></entry> + <entry> + The checkpointer process is currently performing two phase checkpoint. + </entry> + </row> + <row> + <entry><literal>performing post checkpoint cleanup</literal></entry> + <entry> + The checkpointer process is currently performing post checkpoint cleanup. + It removes any lingering files that can be safely removed. + </entry> + </row> + <row> + <entry><literal>invalidating replication slots</literal></entry> + <entry> + The checkpointer process is currently invalidating replication slots. + </entry> + </row> + <row> + <entry><literal>recycling old WAL files</literal></entry> + <entry> + The checkpointer process is currently recycling old WAL files. + </entry> + </row> + <row> + <entry><literal>truncating subtransactions</literal></entry> + <entry> + The checkpointer process is currently removing the subtransaction + segments. + </entry> + </row> + <row> + <entry><literal>finalizing</literal></entry> + <entry> + The checkpointer process is finalizing the checkpoint operation. + </entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + </sect1> <sect1 id="dynamic-trace"> diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml index 28a1d717b8..906883336d 100644 --- a/doc/src/sgml/ref/checkpoint.sgml +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -55,6 +55,14 @@ CHECKPOINT Only superusers or users with the privileges of the <link linkend="predefined-roles-table"><literal>pg_checkpoint</literal></link> role can call <command>CHECKPOINT</command>. + + <para> + The checkpointer process running the checkpoint will report its progress + in the <structname>pg_stat_progress_checkpoint</structname> view except for + the shutdown and end-of-recovery cases. See + <xref linkend="checkpoint-progress-reporting"/> for details. + </para> + </para> </refsect1> diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index 6a38b53744..733a8d2837 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -531,7 +531,11 @@ adjust the <xref linkend="guc-archive-timeout"/> parameter rather than the checkpoint parameters.) It is also possible to force a checkpoint by using the SQL - command <command>CHECKPOINT</command>. + command <command>CHECKPOINT</command>. The checkpointer process running the + checkpoint will report its progress in the + <structname>pg_stat_progress_checkpoint</structname> view except for the + shutdown and end-of-recovery cases. See + <xref linkend="checkpoint-progress-reporting"/> for details. </para> <para> diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index be54c23187..f2cebe0973 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -67,6 +67,7 @@ #include "catalog/catversion.h" #include "catalog/pg_control.h" #include "catalog/pg_database.h" +#include "commands/progress.h" #include "common/controldata_utils.h" #include "common/file_utils.h" #include "executor/instrument.h" @@ -698,6 +699,8 @@ static void WALInsertLockAcquireExclusive(void); static void WALInsertLockRelease(void); static void WALInsertLockUpdateInsertingAt(XLogRecPtr insertingAt); +static void checkpoint_progress_start(int flags, int type); + /* * Insert an XLOG record represented by an already-constructed chain of data * chunks. This is a low-level routine; to construct the WAL record header @@ -6622,6 +6625,9 @@ CreateCheckPoint(int flags) XLogCtl->RedoRecPtr = checkPoint.redo; SpinLockRelease(&XLogCtl->info_lck); + /* Prepare to report progress of the checkpoint. */ + checkpoint_progress_start(flags, PROGRESS_CHECKPOINT_TYPE_CHECKPOINT); + /* * If enabled, log checkpoint start. We postpone this until now so as not * to log anything if we decided to skip the checkpoint. @@ -6704,6 +6710,8 @@ CreateCheckPoint(int flags) * clog and we will correctly flush the update below. So we cannot miss * any xacts we need to wait for. */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_GET_VIRTUAL_TRANSACTION_IDS); vxids = GetVirtualXIDsDelayingChkpt(&nvxids, DELAY_CHKPT_START); if (nvxids > 0) { @@ -6819,6 +6827,8 @@ CreateCheckPoint(int flags) /* * Let smgr do post-checkpoint cleanup (eg, deleting old files). */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_POST_CHECKPOINT_CLEANUP); SyncPostCheckpoint(); /* @@ -6834,6 +6844,9 @@ CreateCheckPoint(int flags) */ XLByteToSeg(RedoRecPtr, _logSegNo, wal_segment_size); KeepLogSeg(recptr, &_logSegNo); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS); + if (InvalidateObsoleteReplicationSlots(_logSegNo)) { /* @@ -6844,6 +6857,8 @@ CreateCheckPoint(int flags) KeepLogSeg(recptr, &_logSegNo); } _logSegNo--; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG); RemoveOldXlogFiles(_logSegNo, RedoRecPtr, recptr, checkPoint.ThisTimeLineID); @@ -6862,11 +6877,21 @@ CreateCheckPoint(int flags) * StartupSUBTRANS hasn't been called yet. */ if (!RecoveryInProgress()) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS); TruncateSUBTRANS(GetOldestTransactionIdConsideredRunning()); + } + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_FINALIZE); /* Real work is done; log and update stats. */ LogCheckpointEnd(false); + /* Stop reporting progress of the checkpoint. */ + pgstat_progress_end_command(); + /* Reset the process title */ update_checkpoint_display(flags, false, true); @@ -7023,29 +7048,63 @@ static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags) { CheckPointRelationMap(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_REPLI_SLOTS); CheckPointReplicationSlots(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SNAPSHOTS); CheckPointSnapBuild(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_LOGICAL_REWRITE_MAPPINGS); CheckPointLogicalRewriteHeap(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_REPLI_ORIGIN); CheckPointReplicationOrigin(); /* Write out all dirty data in SLRUs and the main buffer pool */ TRACE_POSTGRESQL_BUFFER_CHECKPOINT_START(flags); CheckpointStats.ckpt_write_t = GetCurrentTimestamp(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_CLOG_PAGES); CheckPointCLOG(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_COMMITTS_PAGES); CheckPointCommitTs(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SUBTRANS_PAGES); CheckPointSUBTRANS(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_MULTIXACT_PAGES); CheckPointMultiXact(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_PREDICATE_LOCK_PAGES); CheckPointPredicate(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_BUFFERS); CheckPointBuffers(flags); /* Perform all queued up fsyncs */ TRACE_POSTGRESQL_BUFFER_CHECKPOINT_SYNC_START(); CheckpointStats.ckpt_sync_t = GetCurrentTimestamp(); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SYNC_FILES); ProcessSyncRequests(); CheckpointStats.ckpt_sync_end_t = GetCurrentTimestamp(); TRACE_POSTGRESQL_BUFFER_CHECKPOINT_DONE(); /* We deliberately delay 2PC checkpointing as long as possible */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TWO_PHASE); CheckPointTwoPhase(checkPointRedo); } @@ -7195,6 +7254,9 @@ CreateRestartPoint(int flags) MemSet(&CheckpointStats, 0, sizeof(CheckpointStats)); CheckpointStats.ckpt_start_t = GetCurrentTimestamp(); + /* Prepare to report progress of the restartpoint. */ + checkpoint_progress_start(flags, PROGRESS_CHECKPOINT_TYPE_RESTARTPOINT); + if (log_checkpoints) LogCheckpointStart(flags, true); @@ -7278,6 +7340,9 @@ CreateRestartPoint(int flags) replayPtr = GetXLogReplayRecPtr(&replayTLI); endptr = (receivePtr < replayPtr) ? replayPtr : receivePtr; KeepLogSeg(endptr, &_logSegNo); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS); + if (InvalidateObsoleteReplicationSlots(_logSegNo)) { /* @@ -7304,6 +7369,8 @@ CreateRestartPoint(int flags) if (!RecoveryInProgress()) replayTLI = XLogCtl->InsertTimeLineID; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG); RemoveOldXlogFiles(_logSegNo, RedoRecPtr, endptr, replayTLI); /* @@ -7320,11 +7387,20 @@ CreateRestartPoint(int flags) * this because StartupSUBTRANS hasn't been called yet. */ if (EnableHotStandby) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS); TruncateSUBTRANS(GetOldestTransactionIdConsideredRunning()); + } + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_FINALIZE); /* Real work is done; log and update stats. */ LogCheckpointEnd(true); + /* Stop reporting progress of the restartpoint. */ + pgstat_progress_end_command(); + /* Reset the process title */ update_checkpoint_display(flags, true, true); @@ -8958,3 +9034,29 @@ SetWalWriterSleeping(bool sleeping) XLogCtl->WalWriterSleeping = sleeping; SpinLockRelease(&XLogCtl->info_lck); } + +/* + * Start reporting progress of the checkpoint. + */ +static void +checkpoint_progress_start(int flags, int type) +{ + const int index[] = { + PROGRESS_CHECKPOINT_TYPE, + PROGRESS_CHECKPOINT_FLAGS, + PROGRESS_CHECKPOINT_LSN, + PROGRESS_CHECKPOINT_START_TIMESTAMP, + PROGRESS_CHECKPOINT_PHASE + }; + int64 val[5]; + + pgstat_progress_start_command(PROGRESS_COMMAND_CHECKPOINT, InvalidOid); + + val[0] = type; + val[1] = flags; + val[2] = RedoRecPtr; + val[3] = CheckpointStats.ckpt_start_t; + val[4] = PROGRESS_CHECKPOINT_PHASE_INIT; + + pgstat_progress_update_multi_param(5, index, val); +} \ No newline at end of file diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index 2d8104b090..384ca35833 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1267,6 +1267,57 @@ CREATE VIEW pg_stat_progress_copy AS FROM pg_stat_get_progress_info('COPY') AS S LEFT JOIN pg_database D ON S.datid = D.oid; +CREATE VIEW pg_stat_progress_checkpoint AS + SELECT + S.pid AS pid, + CASE S.param1 WHEN 1 THEN 'checkpoint' + WHEN 2 THEN 'restartpoint' + END AS type, + ( CASE WHEN (S.param2 & 4) > 0 THEN 'immediate ' ELSE '' END || + CASE WHEN (S.param2 & 8) > 0 THEN 'force ' ELSE '' END || + CASE WHEN (S.param2 & 16) > 0 THEN 'flush-all ' ELSE '' END || + CASE WHEN (S.param2 & 32) > 0 THEN 'wait ' ELSE '' END || + CASE WHEN (S.param2 & 128) > 0 THEN 'wal ' ELSE '' END || + CASE WHEN (S.param2 & 256) > 0 THEN 'time ' ELSE '' END + ) AS flags, + ( '0/0'::pg_lsn + + ((CASE + WHEN S.param3 < 0 THEN pow(2::numeric, 64::numeric)::numeric + ELSE 0::numeric + END) + + S.param3::numeric) + ) AS start_lsn, + to_timestamp(946684800 + (S.param4::float8 / 1000000)) AS start_time, + CASE S.param5 WHEN 1 THEN 'initializing' + WHEN 2 THEN 'getting virtual transaction IDs' + WHEN 3 THEN 'checkpointing replication slots' + WHEN 4 THEN 'checkpointing logical replication snapshot files' + WHEN 5 THEN 'checkpointing logical rewrite mapping files' + WHEN 6 THEN 'checkpointing replication origin' + WHEN 7 THEN 'checkpointing commit log pages' + WHEN 8 THEN 'checkpointing commit time stamp pages' + WHEN 9 THEN 'checkpointing subtransaction pages' + WHEN 10 THEN 'checkpointing multixact pages' + WHEN 11 THEN 'checkpointing predicate lock pages' + WHEN 12 THEN 'checkpointing buffers' + WHEN 13 THEN 'processing file sync requests' + WHEN 14 THEN 'performing two phase checkpoint' + WHEN 15 THEN 'performing post checkpoint cleanup' + WHEN 16 THEN 'invalidating replication slots' + WHEN 17 THEN 'recycling old WAL files' + WHEN 18 THEN 'truncating subtransactions' + WHEN 19 THEN 'finalizing' + END AS phase, + S.param6 AS buffers_total, + S.param7 AS buffers_processed, + S.param8 AS buffers_written, + S.param9 AS files_total, + S.param10 AS files_synced, + CASE S.param11 WHEN 0 THEN 'false' + WHEN 1 THEN 'true' + END AS new_requests + FROM pg_stat_get_progress_info('CHECKPOINT') AS S; + CREATE VIEW pg_user_mappings AS SELECT U.oid AS umid, diff --git a/src/backend/postmaster/checkpointer.c b/src/backend/postmaster/checkpointer.c index 5fc076fc14..21bf75b058 100644 --- a/src/backend/postmaster/checkpointer.c +++ b/src/backend/postmaster/checkpointer.c @@ -39,6 +39,7 @@ #include "access/xlog.h" #include "access/xlog_internal.h" #include "access/xlogrecovery.h" +#include "commands/progress.h" #include "libpq/pqsignal.h" #include "miscadmin.h" #include "pgstat.h" @@ -163,7 +164,7 @@ static pg_time_t last_xlog_switch_time; static void HandleCheckpointerInterrupts(void); static void CheckArchiveTimeout(void); static bool IsCheckpointOnSchedule(double progress); -static bool ImmediateCheckpointRequested(void); +static bool ImmediateCheckpointRequested(int flags); static bool CompactCheckpointerRequestQueue(void); static void UpdateSharedMemoryConfig(void); @@ -667,16 +668,24 @@ CheckArchiveTimeout(void) * there is one pending behind it.) */ static bool -ImmediateCheckpointRequested(void) +ImmediateCheckpointRequested(int flags) { volatile CheckpointerShmemStruct *cps = CheckpointerShmem; + if (cps->ckpt_flags & CHECKPOINT_REQUESTED) + pgstat_progress_update_param(PROGRESS_CHECKPOINT_NEW_REQUESTS, true); + /* * We don't need to acquire the ckpt_lck in this case because we're only * looking at a single flag bit. */ if (cps->ckpt_flags & CHECKPOINT_IMMEDIATE) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FLAGS, + (flags | CHECKPOINT_IMMEDIATE)); return true; + } + return false; } @@ -708,7 +717,7 @@ CheckpointWriteDelay(int flags, double progress) */ if (!(flags & CHECKPOINT_IMMEDIATE) && !ShutdownRequestPending && - !ImmediateCheckpointRequested() && + !ImmediateCheckpointRequested(flags) && IsCheckpointOnSchedule(progress)) { if (ConfigReloadPending) diff --git a/src/backend/storage/buffer/bufmgr.c b/src/backend/storage/buffer/bufmgr.c index 73d30bf619..6d69255667 100644 --- a/src/backend/storage/buffer/bufmgr.c +++ b/src/backend/storage/buffer/bufmgr.c @@ -39,6 +39,7 @@ #include "catalog/catalog.h" #include "catalog/storage.h" #include "catalog/storage_xlog.h" +#include "commands/progress.h" #include "executor/instrument.h" #include "lib/binaryheap.h" #include "miscadmin.h" @@ -2026,6 +2027,8 @@ BufferSync(int flags) WritebackContextInit(&wb_context, &checkpoint_flush_after); TRACE_POSTGRESQL_BUFFER_SYNC_START(NBuffers, num_to_scan); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_TOTAL, + num_to_scan); /* * Sort buffers that need to be written to reduce the likelihood of random @@ -2143,6 +2146,8 @@ BufferSync(int flags) bufHdr = GetBufferDescriptor(buf_id); num_processed++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_PROCESSED, + num_processed); /* * We don't need to acquire the lock here, because we're only looking @@ -2163,6 +2168,8 @@ BufferSync(int flags) TRACE_POSTGRESQL_BUFFER_SYNC_WRITTEN(buf_id); PendingCheckpointerStats.buf_written_checkpoints++; num_written++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_WRITTEN, + num_written); } } diff --git a/src/backend/storage/sync/sync.c b/src/backend/storage/sync/sync.c index 9d6a9e9109..aa25215910 100644 --- a/src/backend/storage/sync/sync.c +++ b/src/backend/storage/sync/sync.c @@ -23,6 +23,7 @@ #include "access/multixact.h" #include "access/xlog.h" #include "access/xlogutils.h" +#include "commands/progress.h" #include "commands/tablespace.h" #include "miscadmin.h" #include "pgstat.h" @@ -368,6 +369,9 @@ ProcessSyncRequests(void) /* Now scan the hashtable for fsync requests to process */ absorb_counter = FSYNCS_PER_ABSORB; hash_seq_init(&hstat, pendingOps); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FILES_TOTAL, + hash_get_num_entries(pendingOps)); + while ((entry = (PendingFsyncEntry *) hash_seq_search(&hstat)) != NULL) { int failures; @@ -431,6 +435,8 @@ ProcessSyncRequests(void) longest = elapsed; total_elapsed += elapsed; processed++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FILES_SYNCED, + processed); if (log_checkpoints) elog(DEBUG1, "checkpoint sync: number=%d file=%s time=%.3f ms", diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c index 96bffc0f2a..8281d961bf 100644 --- a/src/backend/utils/adt/pgstatfuncs.c +++ b/src/backend/utils/adt/pgstatfuncs.c @@ -497,6 +497,8 @@ pg_stat_get_progress_info(PG_FUNCTION_ARGS) cmdtype = PROGRESS_COMMAND_BASEBACKUP; else if (pg_strcasecmp(cmd, "COPY") == 0) cmdtype = PROGRESS_COMMAND_COPY; + else if (pg_strcasecmp(cmd, "CHECKPOINT") == 0) + cmdtype = PROGRESS_COMMAND_CHECKPOINT; else ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), diff --git a/src/include/commands/progress.h b/src/include/commands/progress.h index a28938caf4..33a64d2f0b 100644 --- a/src/include/commands/progress.h +++ b/src/include/commands/progress.h @@ -151,4 +151,42 @@ #define PROGRESS_COPY_TYPE_PIPE 3 #define PROGRESS_COPY_TYPE_CALLBACK 4 +/* Progress parameters for checkpoint */ +#define PROGRESS_CHECKPOINT_TYPE 0 +#define PROGRESS_CHECKPOINT_FLAGS 1 +#define PROGRESS_CHECKPOINT_LSN 2 +#define PROGRESS_CHECKPOINT_START_TIMESTAMP 3 +#define PROGRESS_CHECKPOINT_PHASE 4 +#define PROGRESS_CHECKPOINT_BUFFERS_TOTAL 5 +#define PROGRESS_CHECKPOINT_BUFFERS_PROCESSED 6 +#define PROGRESS_CHECKPOINT_BUFFERS_WRITTEN 7 +#define PROGRESS_CHECKPOINT_FILES_TOTAL 8 +#define PROGRESS_CHECKPOINT_FILES_SYNCED 9 +#define PROGRESS_CHECKPOINT_NEW_REQUESTS 10 + +/* Types of checkpoint (as advertised via PROGRESS_CHECKPOINT_TYPE) */ +#define PROGRESS_CHECKPOINT_TYPE_CHECKPOINT 1 +#define PROGRESS_CHECKPOINT_TYPE_RESTARTPOINT 2 + +/* Phases of checkpoint (as advertised via PROGRESS_CHECKPOINT_PHASE) */ +#define PROGRESS_CHECKPOINT_PHASE_INIT 1 +#define PROGRESS_CHECKPOINT_PHASE_GET_VIRTUAL_TRANSACTION_IDS 2 +#define PROGRESS_CHECKPOINT_PHASE_REPLI_SLOTS 3 +#define PROGRESS_CHECKPOINT_PHASE_SNAPSHOTS 4 +#define PROGRESS_CHECKPOINT_PHASE_LOGICAL_REWRITE_MAPPINGS 5 +#define PROGRESS_CHECKPOINT_PHASE_REPLI_ORIGIN 6 +#define PROGRESS_CHECKPOINT_PHASE_CLOG_PAGES 7 +#define PROGRESS_CHECKPOINT_PHASE_COMMITTS_PAGES 8 +#define PROGRESS_CHECKPOINT_PHASE_SUBTRANS_PAGES 9 +#define PROGRESS_CHECKPOINT_PHASE_MULTIXACT_PAGES 10 +#define PROGRESS_CHECKPOINT_PHASE_PREDICATE_LOCK_PAGES 11 +#define PROGRESS_CHECKPOINT_PHASE_BUFFERS 12 +#define PROGRESS_CHECKPOINT_PHASE_SYNC_FILES 13 +#define PROGRESS_CHECKPOINT_PHASE_TWO_PHASE 14 +#define PROGRESS_CHECKPOINT_PHASE_POST_CHECKPOINT_CLEANUP 15 +#define PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS 16 +#define PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG 17 +#define PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS 18 +#define PROGRESS_CHECKPOINT_PHASE_FINALIZE 19 + #endif diff --git a/src/include/utils/backend_progress.h b/src/include/utils/backend_progress.h index 47bf8029b0..02d51fb948 100644 --- a/src/include/utils/backend_progress.h +++ b/src/include/utils/backend_progress.h @@ -27,7 +27,8 @@ typedef enum ProgressCommandType PROGRESS_COMMAND_CLUSTER, PROGRESS_COMMAND_CREATE_INDEX, PROGRESS_COMMAND_BASEBACKUP, - PROGRESS_COMMAND_COPY + PROGRESS_COMMAND_COPY, + PROGRESS_COMMAND_CHECKPOINT } ProgressCommandType; #define PGSTAT_NUM_PROGRESS_PARAM 20 diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 624d0e5aae..eab68d7f14 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1913,6 +1913,76 @@ pg_stat_progress_basebackup| SELECT s.pid, s.param4 AS tablespaces_total, s.param5 AS tablespaces_streamed FROM pg_stat_get_progress_info('BASEBACKUP'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); +pg_stat_progress_checkpoint| SELECT s.pid, + CASE s.param1 + WHEN 1 THEN 'checkpoint'::text + WHEN 2 THEN 'restartpoint'::text + ELSE NULL::text + END AS type, + ((((( + CASE + WHEN ((s.param2 & (4)::bigint) > 0) THEN 'immediate '::text + ELSE ''::text + END || + CASE + WHEN ((s.param2 & (8)::bigint) > 0) THEN 'force '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (16)::bigint) > 0) THEN 'flush-all '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (32)::bigint) > 0) THEN 'wait '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (128)::bigint) > 0) THEN 'wal '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (256)::bigint) > 0) THEN 'time '::text + ELSE ''::text + END) AS flags, + ('0/0'::pg_lsn + ( + CASE + WHEN (s.param3 < 0) THEN pow((2)::numeric, (64)::numeric) + ELSE (0)::numeric + END + (s.param3)::numeric)) AS start_lsn, + to_timestamp(((946684800)::double precision + ((s.param4)::double precision / (1000000)::double precision))) AS start_time, + CASE s.param5 + WHEN 1 THEN 'initializing'::text + WHEN 2 THEN 'getting virtual transaction IDs'::text + WHEN 3 THEN 'checkpointing replication slots'::text + WHEN 4 THEN 'checkpointing logical replication snapshot files'::text + WHEN 5 THEN 'checkpointing logical rewrite mapping files'::text + WHEN 6 THEN 'checkpointing replication origin'::text + WHEN 7 THEN 'checkpointing commit log pages'::text + WHEN 8 THEN 'checkpointing commit time stamp pages'::text + WHEN 9 THEN 'checkpointing subtransaction pages'::text + WHEN 10 THEN 'checkpointing multixact pages'::text + WHEN 11 THEN 'checkpointing predicate lock pages'::text + WHEN 12 THEN 'checkpointing buffers'::text + WHEN 13 THEN 'processing file sync requests'::text + WHEN 14 THEN 'performing two phase checkpoint'::text + WHEN 15 THEN 'performing post checkpoint cleanup'::text + WHEN 16 THEN 'invalidating replication slots'::text + WHEN 17 THEN 'recycling old WAL files'::text + WHEN 18 THEN 'truncating subtransactions'::text + WHEN 19 THEN 'finalizing'::text + ELSE NULL::text + END AS phase, + s.param6 AS buffers_total, + s.param7 AS buffers_processed, + s.param8 AS buffers_written, + s.param9 AS files_total, + s.param10 AS files_synced, + CASE s.param11 + WHEN 0 THEN 'false'::text + WHEN 1 THEN 'true'::text + ELSE NULL::text + END AS new_requests + FROM pg_stat_get_progress_info('CHECKPOINT'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); pg_stat_progress_cluster| SELECT s.pid, s.datid, d.datname, Attachments: [text/plain] v7-0001-pg_stat_progress_checkpoint-view.patch (37.3K, ../../[email protected]/2-v7-0001-pg_stat_progress_checkpoint-view.patch) download | inline diff: commit 5198f5010be0febd019b1888817e2d78b8e42b21 Author: bdrouvot <[email protected]> Date: Thu Nov 3 12:59:10 2022 +0000 v7-0001-pg_stat_progress_checkpoint-view.patch diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index e5d622d514..ceb7d60ffa 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -414,6 +414,13 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser See <xref linkend='copy-progress-reporting'/>. </entry> </row> + + <row> + <entry><structname>pg_stat_progress_checkpoint</structname><indexterm><primary>pg_stat_progress_checkpoint</primary></indexterm></entry> + <entry>One row only, showing the progress of the checkpoint. + See <xref linkend='checkpoint-progress-reporting'/>. + </entry> + </row> </tbody> </tgroup> </table> @@ -5784,7 +5791,7 @@ FROM pg_stat_get_backend_idset() AS backendid; which support progress reporting are <command>ANALYZE</command>, <command>CLUSTER</command>, <command>CREATE INDEX</command>, <command>VACUUM</command>, - <command>COPY</command>, + <command>COPY</command>, <command>CHECKPOINT</command> and <xref linkend="protocol-replication-base-backup"/> (i.e., replication command that <xref linkend="app-pgbasebackup"/> issues to take a base backup). @@ -7072,6 +7079,402 @@ FROM pg_stat_get_backend_idset() AS backendid; </table> </sect2> + <sect2 id="checkpoint-progress-reporting"> + <title>Checkpoint Progress Reporting</title> + + <indexterm> + <primary>pg_stat_progress_checkpoint</primary> + </indexterm> + + <para> + Whenever the checkpoint operation is running, the + <structname>pg_stat_progress_checkpoint</structname> view will contain a + single row indicating the progress of the checkpoint. The tables below + describe the information that will be reported and provide information about + how to interpret it. + </para> + + <table id="pg-stat-progress-checkpoint-view" xreflabel="pg_stat_progress_checkpoint"> + <title><structname>pg_stat_progress_checkpoint</structname> View</title> + <tgroup cols="1"> + <thead> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + Column Type + </para> + <para> + Description + </para></entry> + </row> + </thead> + + <tbody> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>pid</structfield> <type>integer</type> + </para> + <para> + Process ID of the checkpointer process. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>type</structfield> <type>text</type> + </para> + <para> + Type of the checkpoint. See <xref linkend="checkpoint-types"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>flags</structfield> <type>text</type> + </para> + <para> + Flags of the checkpoint. See <xref linkend="checkpoint-flags"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>start_lsn</structfield> <type>text</type> + </para> + <para> + The checkpoint start location. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>start_time</structfield> <type>timestamp with time zone</type> + </para> + <para> + Start time of the checkpoint. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>phase</structfield> <type>text</type> + </para> + <para> + Current processing phase. See <xref linkend="checkpoint-phases"/>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_total</structfield> <type>bigint</type> + </para> + <para> + Total number of buffers to be written. This is estimated and reported + as of the beginning of buffer write operation. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_processed</structfield> <type>bigint</type> + </para> + <para> + Number of buffers processed. This counter increases when the targeted + buffer is processed. This number will eventually become equal to + <literal>buffers_total</literal> when the checkpoint is + complete. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>buffers_written</structfield> <type>bigint</type> + </para> + <para> + Number of buffers written. This counter only advances when the targeted + buffers is written. Note that some of the buffers are processed but may + not required to be written. So this count will always be less than or + equal to <literal>buffers_total</literal>. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>files_total</structfield> <type>bigint</type> + </para> + <para> + Total number of files to be synced. This is estimated and reported as of + the beginning of sync operation. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>files_synced</structfield> <type>bigint</type> + </para> + <para> + Number of files synced. This counter advances when the targeted file is + synced. This number will eventually become equal to + <literal>files_total</literal> when the checkpoint is complete. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>new_requests</structfield> <type>text</type> + </para> + <para> + True if any of the backend is requested for a checkpoint while the + current checkpoint is in progress, False otherwise. + </para></entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-types"> + <title>Checkpoint Types</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Types</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>checkpoint</literal></entry> + <entry> + The current operation is checkpoint. + </entry> + </row> + <row> + <entry><literal>restartpoint</literal></entry> + <entry> + The current operation is restartpoint. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-flags"> + <title>Checkpoint Flags</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Flags</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>shutdown</literal></entry> + <entry> + The checkpoint is for shutdown. + </entry> + </row> + <row> + <entry><literal>end-of-recovery</literal></entry> + <entry> + The checkpoint is for end-of-recovery. + </entry> + </row> + <row> + <entry><literal>immediate</literal></entry> + <entry> + The checkpoint happens without delays. + </entry> + </row> + <row> + <entry><literal>force</literal></entry> + <entry> + The checkpoint is started because some operation (for which the + checkpoint is necessary) forced a checkpoint. + </entry> + </row> + <row> + <entry><literal>flush all</literal></entry> + <entry> + The checkpoint flushes all pages, including those belonging to unlogged + tables. + </entry> + </row> + <row> + <entry><literal>wait</literal></entry> + <entry> + The operations which requested the checkpoint waits for completion + before returning. + </entry> + </row> + <row> + <entry><literal>requested</literal></entry> + <entry> + The checkpoint request has been made. + </entry> + </row> + <row> + <entry><literal>wal</literal></entry> + <entry> + The checkpoint is started because <literal>max_wal_size</literal> is + reached. + </entry> + </row> + <row> + <entry><literal>time</literal></entry> + <entry> + The checkpoint is started because <literal>checkpoint_timeout</literal> + expired. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="checkpoint-phases"> + <title>Checkpoint Phases</title> + <tgroup cols="2"> + <colspec colname="col1" colwidth="1*"/> + <colspec colname="col2" colwidth="2*"/> + <thead> + <row> + <entry>Phase</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>initializing</literal></entry> + <entry> + The checkpointer process is preparing to begin the checkpoint operation. + This phase is expected to be very brief. + </entry> + </row> + <row> + <entry><literal>getting virtual transaction IDs</literal></entry> + <entry> + The checkpointer process is getting the virtual transaction IDs that + are delaying the checkpoint. + </entry> + </row> + <row> + <entry><literal>checkpointing replication slots</literal></entry> + <entry> + The checkpointer process is currently flushing all the replication slots + to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing logical replication snapshot files</literal></entry> + <entry> + The checkpointer process is currently removing all the serialized + snapshot files that are not required anymore. + </entry> + </row> + <row> + <entry><literal>checkpointing logical rewrite mapping files</literal></entry> + <entry> + The checkpointer process is currently removing unwanted or flushing + required logical rewrite mapping files. + </entry> + </row> + <row> + <entry><literal>checkpointing replication origin</literal></entry> + <entry> + The checkpointer process is currently performing a checkpoint of each + replication origin's progress with respect to the replayed remote LSN. + </entry> + </row> + <row> + <entry><literal>checkpointing commit log pages</literal></entry> + <entry> + The checkpointer process is currently writing commit log pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing commit time stamp pages</literal></entry> + <entry> + The checkpointer process is currently writing commit time stamp pages to + disk. + </entry> + </row> + <row> + <entry><literal>checkpointing subtransaction pages</literal></entry> + <entry> + The checkpointer process is currently writing subtransaction pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing multixact pages</literal></entry> + <entry> + The checkpointer process is currently writing multixact pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing predicate lock pages</literal></entry> + <entry> + The checkpointer process is currently writing predicate lock pages to disk. + </entry> + </row> + <row> + <entry><literal>checkpointing buffers</literal></entry> + <entry> + The checkpointer process is currently writing buffers to disk. + </entry> + </row> + <row> + <entry><literal>processing file sync requests</literal></entry> + <entry> + The checkpointer process is currently processing file sync requests. + </entry> + </row> + <row> + <entry><literal>performing two phase checkpoint</literal></entry> + <entry> + The checkpointer process is currently performing two phase checkpoint. + </entry> + </row> + <row> + <entry><literal>performing post checkpoint cleanup</literal></entry> + <entry> + The checkpointer process is currently performing post checkpoint cleanup. + It removes any lingering files that can be safely removed. + </entry> + </row> + <row> + <entry><literal>invalidating replication slots</literal></entry> + <entry> + The checkpointer process is currently invalidating replication slots. + </entry> + </row> + <row> + <entry><literal>recycling old WAL files</literal></entry> + <entry> + The checkpointer process is currently recycling old WAL files. + </entry> + </row> + <row> + <entry><literal>truncating subtransactions</literal></entry> + <entry> + The checkpointer process is currently removing the subtransaction + segments. + </entry> + </row> + <row> + <entry><literal>finalizing</literal></entry> + <entry> + The checkpointer process is finalizing the checkpoint operation. + </entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + </sect1> <sect1 id="dynamic-trace"> diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml index 28a1d717b8..906883336d 100644 --- a/doc/src/sgml/ref/checkpoint.sgml +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -55,6 +55,14 @@ CHECKPOINT Only superusers or users with the privileges of the <link linkend="predefined-roles-table"><literal>pg_checkpoint</literal></link> role can call <command>CHECKPOINT</command>. + + <para> + The checkpointer process running the checkpoint will report its progress + in the <structname>pg_stat_progress_checkpoint</structname> view except for + the shutdown and end-of-recovery cases. See + <xref linkend="checkpoint-progress-reporting"/> for details. + </para> + </para> </refsect1> diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index 6a38b53744..733a8d2837 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -531,7 +531,11 @@ adjust the <xref linkend="guc-archive-timeout"/> parameter rather than the checkpoint parameters.) It is also possible to force a checkpoint by using the SQL - command <command>CHECKPOINT</command>. + command <command>CHECKPOINT</command>. The checkpointer process running the + checkpoint will report its progress in the + <structname>pg_stat_progress_checkpoint</structname> view except for the + shutdown and end-of-recovery cases. See + <xref linkend="checkpoint-progress-reporting"/> for details. </para> <para> diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index be54c23187..f2cebe0973 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -67,6 +67,7 @@ #include "catalog/catversion.h" #include "catalog/pg_control.h" #include "catalog/pg_database.h" +#include "commands/progress.h" #include "common/controldata_utils.h" #include "common/file_utils.h" #include "executor/instrument.h" @@ -698,6 +699,8 @@ static void WALInsertLockAcquireExclusive(void); static void WALInsertLockRelease(void); static void WALInsertLockUpdateInsertingAt(XLogRecPtr insertingAt); +static void checkpoint_progress_start(int flags, int type); + /* * Insert an XLOG record represented by an already-constructed chain of data * chunks. This is a low-level routine; to construct the WAL record header @@ -6622,6 +6625,9 @@ CreateCheckPoint(int flags) XLogCtl->RedoRecPtr = checkPoint.redo; SpinLockRelease(&XLogCtl->info_lck); + /* Prepare to report progress of the checkpoint. */ + checkpoint_progress_start(flags, PROGRESS_CHECKPOINT_TYPE_CHECKPOINT); + /* * If enabled, log checkpoint start. We postpone this until now so as not * to log anything if we decided to skip the checkpoint. @@ -6704,6 +6710,8 @@ CreateCheckPoint(int flags) * clog and we will correctly flush the update below. So we cannot miss * any xacts we need to wait for. */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_GET_VIRTUAL_TRANSACTION_IDS); vxids = GetVirtualXIDsDelayingChkpt(&nvxids, DELAY_CHKPT_START); if (nvxids > 0) { @@ -6819,6 +6827,8 @@ CreateCheckPoint(int flags) /* * Let smgr do post-checkpoint cleanup (eg, deleting old files). */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_POST_CHECKPOINT_CLEANUP); SyncPostCheckpoint(); /* @@ -6834,6 +6844,9 @@ CreateCheckPoint(int flags) */ XLByteToSeg(RedoRecPtr, _logSegNo, wal_segment_size); KeepLogSeg(recptr, &_logSegNo); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS); + if (InvalidateObsoleteReplicationSlots(_logSegNo)) { /* @@ -6844,6 +6857,8 @@ CreateCheckPoint(int flags) KeepLogSeg(recptr, &_logSegNo); } _logSegNo--; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG); RemoveOldXlogFiles(_logSegNo, RedoRecPtr, recptr, checkPoint.ThisTimeLineID); @@ -6862,11 +6877,21 @@ CreateCheckPoint(int flags) * StartupSUBTRANS hasn't been called yet. */ if (!RecoveryInProgress()) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS); TruncateSUBTRANS(GetOldestTransactionIdConsideredRunning()); + } + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_FINALIZE); /* Real work is done; log and update stats. */ LogCheckpointEnd(false); + /* Stop reporting progress of the checkpoint. */ + pgstat_progress_end_command(); + /* Reset the process title */ update_checkpoint_display(flags, false, true); @@ -7023,29 +7048,63 @@ static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags) { CheckPointRelationMap(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_REPLI_SLOTS); CheckPointReplicationSlots(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SNAPSHOTS); CheckPointSnapBuild(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_LOGICAL_REWRITE_MAPPINGS); CheckPointLogicalRewriteHeap(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_REPLI_ORIGIN); CheckPointReplicationOrigin(); /* Write out all dirty data in SLRUs and the main buffer pool */ TRACE_POSTGRESQL_BUFFER_CHECKPOINT_START(flags); CheckpointStats.ckpt_write_t = GetCurrentTimestamp(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_CLOG_PAGES); CheckPointCLOG(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_COMMITTS_PAGES); CheckPointCommitTs(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SUBTRANS_PAGES); CheckPointSUBTRANS(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_MULTIXACT_PAGES); CheckPointMultiXact(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_PREDICATE_LOCK_PAGES); CheckPointPredicate(); + + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_BUFFERS); CheckPointBuffers(flags); /* Perform all queued up fsyncs */ TRACE_POSTGRESQL_BUFFER_CHECKPOINT_SYNC_START(); CheckpointStats.ckpt_sync_t = GetCurrentTimestamp(); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_SYNC_FILES); ProcessSyncRequests(); CheckpointStats.ckpt_sync_end_t = GetCurrentTimestamp(); TRACE_POSTGRESQL_BUFFER_CHECKPOINT_DONE(); /* We deliberately delay 2PC checkpointing as long as possible */ + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TWO_PHASE); CheckPointTwoPhase(checkPointRedo); } @@ -7195,6 +7254,9 @@ CreateRestartPoint(int flags) MemSet(&CheckpointStats, 0, sizeof(CheckpointStats)); CheckpointStats.ckpt_start_t = GetCurrentTimestamp(); + /* Prepare to report progress of the restartpoint. */ + checkpoint_progress_start(flags, PROGRESS_CHECKPOINT_TYPE_RESTARTPOINT); + if (log_checkpoints) LogCheckpointStart(flags, true); @@ -7278,6 +7340,9 @@ CreateRestartPoint(int flags) replayPtr = GetXLogReplayRecPtr(&replayTLI); endptr = (receivePtr < replayPtr) ? replayPtr : receivePtr; KeepLogSeg(endptr, &_logSegNo); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS); + if (InvalidateObsoleteReplicationSlots(_logSegNo)) { /* @@ -7304,6 +7369,8 @@ CreateRestartPoint(int flags) if (!RecoveryInProgress()) replayTLI = XLogCtl->InsertTimeLineID; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG); RemoveOldXlogFiles(_logSegNo, RedoRecPtr, endptr, replayTLI); /* @@ -7320,11 +7387,20 @@ CreateRestartPoint(int flags) * this because StartupSUBTRANS hasn't been called yet. */ if (EnableHotStandby) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS); TruncateSUBTRANS(GetOldestTransactionIdConsideredRunning()); + } + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, + PROGRESS_CHECKPOINT_PHASE_FINALIZE); /* Real work is done; log and update stats. */ LogCheckpointEnd(true); + /* Stop reporting progress of the restartpoint. */ + pgstat_progress_end_command(); + /* Reset the process title */ update_checkpoint_display(flags, true, true); @@ -8958,3 +9034,29 @@ SetWalWriterSleeping(bool sleeping) XLogCtl->WalWriterSleeping = sleeping; SpinLockRelease(&XLogCtl->info_lck); } + +/* + * Start reporting progress of the checkpoint. + */ +static void +checkpoint_progress_start(int flags, int type) +{ + const int index[] = { + PROGRESS_CHECKPOINT_TYPE, + PROGRESS_CHECKPOINT_FLAGS, + PROGRESS_CHECKPOINT_LSN, + PROGRESS_CHECKPOINT_START_TIMESTAMP, + PROGRESS_CHECKPOINT_PHASE + }; + int64 val[5]; + + pgstat_progress_start_command(PROGRESS_COMMAND_CHECKPOINT, InvalidOid); + + val[0] = type; + val[1] = flags; + val[2] = RedoRecPtr; + val[3] = CheckpointStats.ckpt_start_t; + val[4] = PROGRESS_CHECKPOINT_PHASE_INIT; + + pgstat_progress_update_multi_param(5, index, val); +} \ No newline at end of file diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index 2d8104b090..384ca35833 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1267,6 +1267,57 @@ CREATE VIEW pg_stat_progress_copy AS FROM pg_stat_get_progress_info('COPY') AS S LEFT JOIN pg_database D ON S.datid = D.oid; +CREATE VIEW pg_stat_progress_checkpoint AS + SELECT + S.pid AS pid, + CASE S.param1 WHEN 1 THEN 'checkpoint' + WHEN 2 THEN 'restartpoint' + END AS type, + ( CASE WHEN (S.param2 & 4) > 0 THEN 'immediate ' ELSE '' END || + CASE WHEN (S.param2 & 8) > 0 THEN 'force ' ELSE '' END || + CASE WHEN (S.param2 & 16) > 0 THEN 'flush-all ' ELSE '' END || + CASE WHEN (S.param2 & 32) > 0 THEN 'wait ' ELSE '' END || + CASE WHEN (S.param2 & 128) > 0 THEN 'wal ' ELSE '' END || + CASE WHEN (S.param2 & 256) > 0 THEN 'time ' ELSE '' END + ) AS flags, + ( '0/0'::pg_lsn + + ((CASE + WHEN S.param3 < 0 THEN pow(2::numeric, 64::numeric)::numeric + ELSE 0::numeric + END) + + S.param3::numeric) + ) AS start_lsn, + to_timestamp(946684800 + (S.param4::float8 / 1000000)) AS start_time, + CASE S.param5 WHEN 1 THEN 'initializing' + WHEN 2 THEN 'getting virtual transaction IDs' + WHEN 3 THEN 'checkpointing replication slots' + WHEN 4 THEN 'checkpointing logical replication snapshot files' + WHEN 5 THEN 'checkpointing logical rewrite mapping files' + WHEN 6 THEN 'checkpointing replication origin' + WHEN 7 THEN 'checkpointing commit log pages' + WHEN 8 THEN 'checkpointing commit time stamp pages' + WHEN 9 THEN 'checkpointing subtransaction pages' + WHEN 10 THEN 'checkpointing multixact pages' + WHEN 11 THEN 'checkpointing predicate lock pages' + WHEN 12 THEN 'checkpointing buffers' + WHEN 13 THEN 'processing file sync requests' + WHEN 14 THEN 'performing two phase checkpoint' + WHEN 15 THEN 'performing post checkpoint cleanup' + WHEN 16 THEN 'invalidating replication slots' + WHEN 17 THEN 'recycling old WAL files' + WHEN 18 THEN 'truncating subtransactions' + WHEN 19 THEN 'finalizing' + END AS phase, + S.param6 AS buffers_total, + S.param7 AS buffers_processed, + S.param8 AS buffers_written, + S.param9 AS files_total, + S.param10 AS files_synced, + CASE S.param11 WHEN 0 THEN 'false' + WHEN 1 THEN 'true' + END AS new_requests + FROM pg_stat_get_progress_info('CHECKPOINT') AS S; + CREATE VIEW pg_user_mappings AS SELECT U.oid AS umid, diff --git a/src/backend/postmaster/checkpointer.c b/src/backend/postmaster/checkpointer.c index 5fc076fc14..21bf75b058 100644 --- a/src/backend/postmaster/checkpointer.c +++ b/src/backend/postmaster/checkpointer.c @@ -39,6 +39,7 @@ #include "access/xlog.h" #include "access/xlog_internal.h" #include "access/xlogrecovery.h" +#include "commands/progress.h" #include "libpq/pqsignal.h" #include "miscadmin.h" #include "pgstat.h" @@ -163,7 +164,7 @@ static pg_time_t last_xlog_switch_time; static void HandleCheckpointerInterrupts(void); static void CheckArchiveTimeout(void); static bool IsCheckpointOnSchedule(double progress); -static bool ImmediateCheckpointRequested(void); +static bool ImmediateCheckpointRequested(int flags); static bool CompactCheckpointerRequestQueue(void); static void UpdateSharedMemoryConfig(void); @@ -667,16 +668,24 @@ CheckArchiveTimeout(void) * there is one pending behind it.) */ static bool -ImmediateCheckpointRequested(void) +ImmediateCheckpointRequested(int flags) { volatile CheckpointerShmemStruct *cps = CheckpointerShmem; + if (cps->ckpt_flags & CHECKPOINT_REQUESTED) + pgstat_progress_update_param(PROGRESS_CHECKPOINT_NEW_REQUESTS, true); + /* * We don't need to acquire the ckpt_lck in this case because we're only * looking at a single flag bit. */ if (cps->ckpt_flags & CHECKPOINT_IMMEDIATE) + { + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FLAGS, + (flags | CHECKPOINT_IMMEDIATE)); return true; + } + return false; } @@ -708,7 +717,7 @@ CheckpointWriteDelay(int flags, double progress) */ if (!(flags & CHECKPOINT_IMMEDIATE) && !ShutdownRequestPending && - !ImmediateCheckpointRequested() && + !ImmediateCheckpointRequested(flags) && IsCheckpointOnSchedule(progress)) { if (ConfigReloadPending) diff --git a/src/backend/storage/buffer/bufmgr.c b/src/backend/storage/buffer/bufmgr.c index 73d30bf619..6d69255667 100644 --- a/src/backend/storage/buffer/bufmgr.c +++ b/src/backend/storage/buffer/bufmgr.c @@ -39,6 +39,7 @@ #include "catalog/catalog.h" #include "catalog/storage.h" #include "catalog/storage_xlog.h" +#include "commands/progress.h" #include "executor/instrument.h" #include "lib/binaryheap.h" #include "miscadmin.h" @@ -2026,6 +2027,8 @@ BufferSync(int flags) WritebackContextInit(&wb_context, &checkpoint_flush_after); TRACE_POSTGRESQL_BUFFER_SYNC_START(NBuffers, num_to_scan); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_TOTAL, + num_to_scan); /* * Sort buffers that need to be written to reduce the likelihood of random @@ -2143,6 +2146,8 @@ BufferSync(int flags) bufHdr = GetBufferDescriptor(buf_id); num_processed++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_PROCESSED, + num_processed); /* * We don't need to acquire the lock here, because we're only looking @@ -2163,6 +2168,8 @@ BufferSync(int flags) TRACE_POSTGRESQL_BUFFER_SYNC_WRITTEN(buf_id); PendingCheckpointerStats.buf_written_checkpoints++; num_written++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_BUFFERS_WRITTEN, + num_written); } } diff --git a/src/backend/storage/sync/sync.c b/src/backend/storage/sync/sync.c index 9d6a9e9109..aa25215910 100644 --- a/src/backend/storage/sync/sync.c +++ b/src/backend/storage/sync/sync.c @@ -23,6 +23,7 @@ #include "access/multixact.h" #include "access/xlog.h" #include "access/xlogutils.h" +#include "commands/progress.h" #include "commands/tablespace.h" #include "miscadmin.h" #include "pgstat.h" @@ -368,6 +369,9 @@ ProcessSyncRequests(void) /* Now scan the hashtable for fsync requests to process */ absorb_counter = FSYNCS_PER_ABSORB; hash_seq_init(&hstat, pendingOps); + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FILES_TOTAL, + hash_get_num_entries(pendingOps)); + while ((entry = (PendingFsyncEntry *) hash_seq_search(&hstat)) != NULL) { int failures; @@ -431,6 +435,8 @@ ProcessSyncRequests(void) longest = elapsed; total_elapsed += elapsed; processed++; + pgstat_progress_update_param(PROGRESS_CHECKPOINT_FILES_SYNCED, + processed); if (log_checkpoints) elog(DEBUG1, "checkpoint sync: number=%d file=%s time=%.3f ms", diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c index 96bffc0f2a..8281d961bf 100644 --- a/src/backend/utils/adt/pgstatfuncs.c +++ b/src/backend/utils/adt/pgstatfuncs.c @@ -497,6 +497,8 @@ pg_stat_get_progress_info(PG_FUNCTION_ARGS) cmdtype = PROGRESS_COMMAND_BASEBACKUP; else if (pg_strcasecmp(cmd, "COPY") == 0) cmdtype = PROGRESS_COMMAND_COPY; + else if (pg_strcasecmp(cmd, "CHECKPOINT") == 0) + cmdtype = PROGRESS_COMMAND_CHECKPOINT; else ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), diff --git a/src/include/commands/progress.h b/src/include/commands/progress.h index a28938caf4..33a64d2f0b 100644 --- a/src/include/commands/progress.h +++ b/src/include/commands/progress.h @@ -151,4 +151,42 @@ #define PROGRESS_COPY_TYPE_PIPE 3 #define PROGRESS_COPY_TYPE_CALLBACK 4 +/* Progress parameters for checkpoint */ +#define PROGRESS_CHECKPOINT_TYPE 0 +#define PROGRESS_CHECKPOINT_FLAGS 1 +#define PROGRESS_CHECKPOINT_LSN 2 +#define PROGRESS_CHECKPOINT_START_TIMESTAMP 3 +#define PROGRESS_CHECKPOINT_PHASE 4 +#define PROGRESS_CHECKPOINT_BUFFERS_TOTAL 5 +#define PROGRESS_CHECKPOINT_BUFFERS_PROCESSED 6 +#define PROGRESS_CHECKPOINT_BUFFERS_WRITTEN 7 +#define PROGRESS_CHECKPOINT_FILES_TOTAL 8 +#define PROGRESS_CHECKPOINT_FILES_SYNCED 9 +#define PROGRESS_CHECKPOINT_NEW_REQUESTS 10 + +/* Types of checkpoint (as advertised via PROGRESS_CHECKPOINT_TYPE) */ +#define PROGRESS_CHECKPOINT_TYPE_CHECKPOINT 1 +#define PROGRESS_CHECKPOINT_TYPE_RESTARTPOINT 2 + +/* Phases of checkpoint (as advertised via PROGRESS_CHECKPOINT_PHASE) */ +#define PROGRESS_CHECKPOINT_PHASE_INIT 1 +#define PROGRESS_CHECKPOINT_PHASE_GET_VIRTUAL_TRANSACTION_IDS 2 +#define PROGRESS_CHECKPOINT_PHASE_REPLI_SLOTS 3 +#define PROGRESS_CHECKPOINT_PHASE_SNAPSHOTS 4 +#define PROGRESS_CHECKPOINT_PHASE_LOGICAL_REWRITE_MAPPINGS 5 +#define PROGRESS_CHECKPOINT_PHASE_REPLI_ORIGIN 6 +#define PROGRESS_CHECKPOINT_PHASE_CLOG_PAGES 7 +#define PROGRESS_CHECKPOINT_PHASE_COMMITTS_PAGES 8 +#define PROGRESS_CHECKPOINT_PHASE_SUBTRANS_PAGES 9 +#define PROGRESS_CHECKPOINT_PHASE_MULTIXACT_PAGES 10 +#define PROGRESS_CHECKPOINT_PHASE_PREDICATE_LOCK_PAGES 11 +#define PROGRESS_CHECKPOINT_PHASE_BUFFERS 12 +#define PROGRESS_CHECKPOINT_PHASE_SYNC_FILES 13 +#define PROGRESS_CHECKPOINT_PHASE_TWO_PHASE 14 +#define PROGRESS_CHECKPOINT_PHASE_POST_CHECKPOINT_CLEANUP 15 +#define PROGRESS_CHECKPOINT_PHASE_INVALIDATE_REPLI_SLOTS 16 +#define PROGRESS_CHECKPOINT_PHASE_RECYCLE_OLD_XLOG 17 +#define PROGRESS_CHECKPOINT_PHASE_TRUNCATE_SUBTRANS 18 +#define PROGRESS_CHECKPOINT_PHASE_FINALIZE 19 + #endif diff --git a/src/include/utils/backend_progress.h b/src/include/utils/backend_progress.h index 47bf8029b0..02d51fb948 100644 --- a/src/include/utils/backend_progress.h +++ b/src/include/utils/backend_progress.h @@ -27,7 +27,8 @@ typedef enum ProgressCommandType PROGRESS_COMMAND_CLUSTER, PROGRESS_COMMAND_CREATE_INDEX, PROGRESS_COMMAND_BASEBACKUP, - PROGRESS_COMMAND_COPY + PROGRESS_COMMAND_COPY, + PROGRESS_COMMAND_CHECKPOINT } ProgressCommandType; #define PGSTAT_NUM_PROGRESS_PARAM 20 diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 624d0e5aae..eab68d7f14 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1913,6 +1913,76 @@ pg_stat_progress_basebackup| SELECT s.pid, s.param4 AS tablespaces_total, s.param5 AS tablespaces_streamed FROM pg_stat_get_progress_info('BASEBACKUP'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); +pg_stat_progress_checkpoint| SELECT s.pid, + CASE s.param1 + WHEN 1 THEN 'checkpoint'::text + WHEN 2 THEN 'restartpoint'::text + ELSE NULL::text + END AS type, + ((((( + CASE + WHEN ((s.param2 & (4)::bigint) > 0) THEN 'immediate '::text + ELSE ''::text + END || + CASE + WHEN ((s.param2 & (8)::bigint) > 0) THEN 'force '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (16)::bigint) > 0) THEN 'flush-all '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (32)::bigint) > 0) THEN 'wait '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (128)::bigint) > 0) THEN 'wal '::text + ELSE ''::text + END) || + CASE + WHEN ((s.param2 & (256)::bigint) > 0) THEN 'time '::text + ELSE ''::text + END) AS flags, + ('0/0'::pg_lsn + ( + CASE + WHEN (s.param3 < 0) THEN pow((2)::numeric, (64)::numeric) + ELSE (0)::numeric + END + (s.param3)::numeric)) AS start_lsn, + to_timestamp(((946684800)::double precision + ((s.param4)::double precision / (1000000)::double precision))) AS start_time, + CASE s.param5 + WHEN 1 THEN 'initializing'::text + WHEN 2 THEN 'getting virtual transaction IDs'::text + WHEN 3 THEN 'checkpointing replication slots'::text + WHEN 4 THEN 'checkpointing logical replication snapshot files'::text + WHEN 5 THEN 'checkpointing logical rewrite mapping files'::text + WHEN 6 THEN 'checkpointing replication origin'::text + WHEN 7 THEN 'checkpointing commit log pages'::text + WHEN 8 THEN 'checkpointing commit time stamp pages'::text + WHEN 9 THEN 'checkpointing subtransaction pages'::text + WHEN 10 THEN 'checkpointing multixact pages'::text + WHEN 11 THEN 'checkpointing predicate lock pages'::text + WHEN 12 THEN 'checkpointing buffers'::text + WHEN 13 THEN 'processing file sync requests'::text + WHEN 14 THEN 'performing two phase checkpoint'::text + WHEN 15 THEN 'performing post checkpoint cleanup'::text + WHEN 16 THEN 'invalidating replication slots'::text + WHEN 17 THEN 'recycling old WAL files'::text + WHEN 18 THEN 'truncating subtransactions'::text + WHEN 19 THEN 'finalizing'::text + ELSE NULL::text + END AS phase, + s.param6 AS buffers_total, + s.param7 AS buffers_processed, + s.param8 AS buffers_written, + s.param9 AS files_total, + s.param10 AS files_synced, + CASE s.param11 + WHEN 0 THEN 'false'::text + WHEN 1 THEN 'true'::text + ELSE NULL::text + END AS new_requests + FROM pg_stat_get_progress_info('CHECKPOINT'::text) s(pid, datid, relid, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20); pg_stat_progress_cluster| SELECT s.pid, s.datid, d.datname, ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-15 11:41 Nitin Jadhav <[email protected]> parent: Drouvot, Bertrand <[email protected]> 3 siblings, 0 replies; 32+ messages in thread From: Nitin Jadhav @ 2022-11-15 11:41 UTC (permalink / raw) To: Drouvot, Bertrand <[email protected]>; +Cc: Andres Freund <[email protected]>; Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> > v6 was not applying anymore, due to a change in > doc/src/sgml/ref/checkpoint.sgml done by b9eb0ff09e (Rename > pg_checkpointer predefined role to pg_checkpoint). > > Please find attached a rebase in v7. > > While working on this rebase, I also noticed that "pg_checkpointer" is > still mentioned in some translation files: Thanks for rebasing the patch and sharing the information. --- > That said, back to this patch: I did not look closely but noticed that > the buffers_total reported by pg_stat_progress_checkpoint: > > postgres=# select type,flags,start_lsn,phase,buffers_total,new_requests > from pg_stat_progress_checkpoint; > type | flags | start_lsn | phase > | buffers_total | new_requests > ------------+-----------------------+------------+-----------------------+---------------+-------------- > checkpoint | immediate force wait | 1/E6C523A8 | checkpointing > buffers | 1024275 | false > (1 row) > > is a little bit different from what is logged once completed: > > 2022-11-04 08:18:50.806 UTC [3488442] LOG: checkpoint complete: wrote > 1024278 buffers (97.7%); This is because the count shown in the checkpoint complete message includes the additional increment done during SlruInternalWritePage(). We are not sure of this increment until it really happens. Hence it was not considered in the patch. To make it compatible with the checkpoint complete message, we should increment all three here, buffers_total, buffers_processed and buffers_written. So the total number of buffers calculated earlier may not always be the same. If this looks good, I will update this in the next patch. Thanks & Regards, Nitin Jadhav On Fri, Nov 4, 2022 at 1:57 PM Drouvot, Bertrand <[email protected]> wrote: > > Hi, > > On 7/28/22 11:38 AM, Nitin Jadhav wrote: > >>> To understand the performance effects of the above, I have taken the > >>> average of five checkpoints with the patch and without the patch in my > >>> environment. Here are the results. > >>> With patch: 269.65 s > >>> Without patch: 269.60 s > >> > >> Those look like timed checkpoints - if the checkpoints are sleeping a > >> part of the time, you're not going to see any potential overhead. > > > > Yes. The above data is collected from timed checkpoints. > > > > create table t1(a int); > > insert into t1 select * from generate_series(1,10000000); > > > > I generated a lot of data by using the above queries which would in > > turn trigger the checkpoint (wal). > > --- > > > >> To see whether this has an effect you'd have to make sure there's a > >> certain number of dirty buffers (e.g. by doing CREATE TABLE AS > >> some_query) and then do a manual checkpoint and time how long that > >> times. > > > > For this case I have generated data by using below queries. > > > > create table t1(a int); > > insert into t1 select * from generate_series(1,8000000); > > > > This does not trigger the checkpoint automatically. I have issued the > > CHECKPOINT manually and measured the performance by considering an > > average of 5 checkpoints. Here are the details. > > > > With patch: 2.457 s > > Without patch: 2.334 s > > > > Please share your thoughts. > > > > v6 was not applying anymore, due to a change in > doc/src/sgml/ref/checkpoint.sgml done by b9eb0ff09e (Rename > pg_checkpointer predefined role to pg_checkpoint). > > Please find attached a rebase in v7. > > While working on this rebase, I also noticed that "pg_checkpointer" is > still mentioned in some translation files: > " > $ git grep pg_checkpointer > src/backend/po/de.po:msgid "must be superuser or have privileges of > pg_checkpointer to do CHECKPOINT" > src/backend/po/ja.po:msgid "must be superuser or have privileges of > pg_checkpointer to do CHECKPOINT" > src/backend/po/ja.po:msgstr > "CHECKPOINTを実行するにはスーパーユーザーであるか、またはpg_checkpointerの権限を持つ必要があります" > src/backend/po/sv.po:msgid "must be superuser or have privileges of > pg_checkpointer to do CHECKPOINT" > " > > I'm not familiar with how the translation files are handled (looks like > they have their own set of commits, see 3c0bcdbc66 for example) but > wanted to mention that "pg_checkpointer" is still mentioned (even if > that may be expected as the last commit related to translation files > (aka 3c0bcdbc66) is older than the one that renamed pg_checkpointer to > pg_checkpoint (aka b9eb0ff09e)). > > That said, back to this patch: I did not look closely but noticed that > the buffers_total reported by pg_stat_progress_checkpoint: > > postgres=# select type,flags,start_lsn,phase,buffers_total,new_requests > from pg_stat_progress_checkpoint; > type | flags | start_lsn | phase > | buffers_total | new_requests > ------------+-----------------------+------------+-----------------------+---------------+-------------- > checkpoint | immediate force wait | 1/E6C523A8 | checkpointing > buffers | 1024275 | false > (1 row) > > is a little bit different from what is logged once completed: > > 2022-11-04 08:18:50.806 UTC [3488442] LOG: checkpoint complete: wrote > 1024278 buffers (97.7%); > > Regards, > > -- > Bertrand Drouvot > PostgreSQL Contributors Team > RDS Open Source Databases > Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-15 20:04 Robert Haas <[email protected]> parent: Drouvot, Bertrand <[email protected]> 3 siblings, 1 reply; 32+ messages in thread From: Robert Haas @ 2022-11-15 20:04 UTC (permalink / raw) To: Drouvot, Bertrand <[email protected]>; +Cc: Nitin Jadhav <[email protected]>; Andres Freund <[email protected]>; Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Nov 4, 2022 at 4:27 AM Drouvot, Bertrand <[email protected]> wrote: > Please find attached a rebase in v7. I don't think it's a good thing that this patch is using the progress-reporting machinery. The point of that machinery is that we want any backend to be able to report progress for any command it happens to be running, and we don't know which command that will be at any given point in time, or how many backends will be running any given command at once. So we need some generic set of counters that can be repurposed for whatever any particular backend happens to be doing right at the moment. But none of that applies to the checkpointer. Any information about the checkpointer that we want to expose can just be advertised in a dedicated chunk of shared memory, perhaps even by simply adding it to CheckpointerShmemStruct. Then you can give the fields whatever names, types, and sizes you like, and you don't have to do all of this stuff with mapping down to integers and back. The only real disadvantage that I can see is then you have to think a bit harder about what the concurrency model is here, and maybe you end up reimplementing something similar to what the progress-reporting stuff does for you, and *maybe* that is a sufficient reason to do it this way. But I'm doubtful. This feels like a square-peg-round-hole situation. -- Robert Haas EDB: http://www.enterprisedb.com ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-15 20:18 Andres Freund <[email protected]> parent: Drouvot, Bertrand <[email protected]> 3 siblings, 0 replies; 32+ messages in thread From: Andres Freund @ 2022-11-15 20:18 UTC (permalink / raw) To: Drouvot, Bertrand <[email protected]>; +Cc: Nitin Jadhav <[email protected]>; Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On 2022-11-04 09:25:52 +0100, Drouvot, Bertrand wrote: > > @@ -7023,29 +7048,63 @@ static void > CheckPointGuts(XLogRecPtr checkPointRedo, int flags) > { > CheckPointRelationMap(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_REPLI_SLOTS); > CheckPointReplicationSlots(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_SNAPSHOTS); > CheckPointSnapBuild(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_LOGICAL_REWRITE_MAPPINGS); > CheckPointLogicalRewriteHeap(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_REPLI_ORIGIN); > CheckPointReplicationOrigin(); > > /* Write out all dirty data in SLRUs and the main buffer pool */ > TRACE_POSTGRESQL_BUFFER_CHECKPOINT_START(flags); > CheckpointStats.ckpt_write_t = GetCurrentTimestamp(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_CLOG_PAGES); > CheckPointCLOG(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_COMMITTS_PAGES); > CheckPointCommitTs(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_SUBTRANS_PAGES); > CheckPointSUBTRANS(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_MULTIXACT_PAGES); > CheckPointMultiXact(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_PREDICATE_LOCK_PAGES); > CheckPointPredicate(); > + > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_BUFFERS); > CheckPointBuffers(flags); > > /* Perform all queued up fsyncs */ > TRACE_POSTGRESQL_BUFFER_CHECKPOINT_SYNC_START(); > CheckpointStats.ckpt_sync_t = GetCurrentTimestamp(); > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_SYNC_FILES); > ProcessSyncRequests(); > CheckpointStats.ckpt_sync_end_t = GetCurrentTimestamp(); > TRACE_POSTGRESQL_BUFFER_CHECKPOINT_DONE(); > > /* We deliberately delay 2PC checkpointing as long as possible */ > + pgstat_progress_update_param(PROGRESS_CHECKPOINT_PHASE, > + PROGRESS_CHECKPOINT_PHASE_TWO_PHASE); > CheckPointTwoPhase(checkPointRedo); > } This is quite the code bloat. Can we make this less duplicative? > +CREATE VIEW pg_stat_progress_checkpoint AS > + SELECT > + S.pid AS pid, > + CASE S.param1 WHEN 1 THEN 'checkpoint' > + WHEN 2 THEN 'restartpoint' > + END AS type, > + ( CASE WHEN (S.param2 & 4) > 0 THEN 'immediate ' ELSE '' END || > + CASE WHEN (S.param2 & 8) > 0 THEN 'force ' ELSE '' END || > + CASE WHEN (S.param2 & 16) > 0 THEN 'flush-all ' ELSE '' END || > + CASE WHEN (S.param2 & 32) > 0 THEN 'wait ' ELSE '' END || > + CASE WHEN (S.param2 & 128) > 0 THEN 'wal ' ELSE '' END || > + CASE WHEN (S.param2 & 256) > 0 THEN 'time ' ELSE '' END > + ) AS flags, > + ( '0/0'::pg_lsn + > + ((CASE > + WHEN S.param3 < 0 THEN pow(2::numeric, 64::numeric)::numeric > + ELSE 0::numeric > + END) + > + S.param3::numeric) > + ) AS start_lsn, I don't think we should embed this much complexity in the view defintions. It's hard to read, bloats the catalog, we can't fix them once released. This stuff seems like it should be in a helper function. I don't have any iea what that pow stuff is supposed to be doing. > + to_timestamp(946684800 + (S.param4::float8 / 1000000)) AS start_time, I don't think this is a reasonable path - embedding way too much low-level details about the timestamp format in the view definition. Why do we need to do this? Greetings, Andres Freund ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-16 10:31 Bharath Rupireddy <[email protected]> parent: Robert Haas <[email protected]> 0 siblings, 2 replies; 32+ messages in thread From: Bharath Rupireddy @ 2022-11-16 10:31 UTC (permalink / raw) To: Robert Haas <[email protected]>; +Cc: Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Andres Freund <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> On Wed, Nov 16, 2022 at 1:35 AM Robert Haas <[email protected]> wrote: > > On Fri, Nov 4, 2022 at 4:27 AM Drouvot, Bertrand > <[email protected]> wrote: > > Please find attached a rebase in v7. > > I don't think it's a good thing that this patch is using the > progress-reporting machinery. The point of that machinery is that we > want any backend to be able to report progress for any command it > happens to be running, and we don't know which command that will be at > any given point in time, or how many backends will be running any > given command at once. So we need some generic set of counters that > can be repurposed for whatever any particular backend happens to be > doing right at the moment. Hm. > But none of that applies to the checkpointer. Any information about > the checkpointer that we want to expose can just be advertised in a > dedicated chunk of shared memory, perhaps even by simply adding it to > CheckpointerShmemStruct. Then you can give the fields whatever names, > types, and sizes you like, and you don't have to do all of this stuff > with mapping down to integers and back. The only real disadvantage > that I can see is then you have to think a bit harder about what the > concurrency model is here, and maybe you end up reimplementing > something similar to what the progress-reporting stuff does for you, > and *maybe* that is a sufficient reason to do it this way. -1 for CheckpointerShmemStruct as it is being used for running checkpoints and I don't think adding stats to it is a great idea. Instead, extending PgStat_CheckpointerStats and using shared memory stats for reporting progress/last checkpoint related stats is a good idea IMO. I also think that a new pg_stat_checkpoint view is needed because, right now, the PgStat_CheckpointerStats stats are exposed via the pg_stat_bgwriter view, having a separate view for checkpoint stats is good here. Also, removing CheckpointStatsData and moving all of those members to PgStat_CheckpointerStats, of course, by being careful about the amount of shared memory required, is also a good idea IMO. Going forward, PgStat_CheckpointerStats and pg_stat_checkpoint view can be a single point of location for all the checkpoint related stats. Thoughts? In fact, I was recently having an off-list chat with Bertrand Drouvot about the above idea. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-16 18:14 Andres Freund <[email protected]> parent: Bharath Rupireddy <[email protected]> 1 sibling, 0 replies; 32+ messages in thread From: Andres Freund @ 2022-11-16 18:14 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Robert Haas <[email protected]>; Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On 2022-11-16 16:01:55 +0530, Bharath Rupireddy wrote: > -1 for CheckpointerShmemStruct as it is being used for running > checkpoints and I don't think adding stats to it is a great idea. Why? Imo the data needed for progress reporting aren't really "stats". We'd not accumulate counters over time, just for the current checkpoint. I think it might even be useful for other parts of the system to know what the checkpointer is doing, e.g. bgwriter or autovacuum could adapt the behaviour if checkpointer can't keep up. Somehow it'd feel wrong to use the stats system as the source of such adjustments - but perhaps my gut feeling on that isn't right. The best argument for combining progress reporting with accumulating stats is that we could likely share some of the code. Having accumulated stats for all the checkpoint phases would e.g. be quite valuable. > Instead, extending PgStat_CheckpointerStats and using shared memory > stats for reporting progress/last checkpoint related stats is a good > idea IMO There's certainly some potential for deduplicating state and to make stats updated more frequently. But that doesn't necessarily mean that putting the checkpoint progress into PgStat_CheckpointerStats is a good idea (nor the opposite). > I also think that a new pg_stat_checkpoint view is needed > because, right now, the PgStat_CheckpointerStats stats are exposed via > the pg_stat_bgwriter view, having a separate view for checkpoint stats > is good here. I agree that we should do that, but largely independent of the architectural question at hand. Greetings, Andres Freund ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-16 19:19 Robert Haas <[email protected]> parent: Bharath Rupireddy <[email protected]> 1 sibling, 2 replies; 32+ messages in thread From: Robert Haas @ 2022-11-16 19:19 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Andres Freund <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> On Wed, Nov 16, 2022 at 5:32 AM Bharath Rupireddy <[email protected]> wrote: > -1 for CheckpointerShmemStruct as it is being used for running > checkpoints and I don't think adding stats to it is a great idea. > Instead, extending PgStat_CheckpointerStats and using shared memory > stats for reporting progress/last checkpoint related stats is a good > idea IMO. I agree with Andres: progress reporting isn't really quite the same thing as stats, and either place seems like it could be reasonable. I don't presently have an opinion on which is a better fit, but I don't think the fact that CheckpointerShmemStruct is used for running checkpoints rules anything out. Progress reporting is *also* about running checkpoints. Any historical data you want to expose might not be about running checkpoints, but, uh, so what? I don't really see that as a strong argument against it fitting into this struct. > I also think that a new pg_stat_checkpoint view is needed > because, right now, the PgStat_CheckpointerStats stats are exposed via > the pg_stat_bgwriter view, having a separate view for checkpoint stats > is good here. Yep. > Also, removing CheckpointStatsData and moving all of > those members to PgStat_CheckpointerStats, of course, by being careful > about the amount of shared memory required, is also a good idea IMO. > Going forward, PgStat_CheckpointerStats and pg_stat_checkpoint view > can be a single point of location for all the checkpoint related > stats. I'm not sure that I completely follow this part, or that I agree with it. I have never really understood why we drive background writer or checkpointer statistics through the statistics collector. Here again, for things like table statistics, there is no choice, because we could have an unbounded number of tables and need to keep statistics about all of them. The statistics collector can handle that by allocating more memory as required. But there is only one background writer and only one checkpointer, so that is not needed in those cases. Why not just have them expose anything they want to expose through shared memory directly? If the statistics collector provides services that we care about, like persisting data across restarts or making snapshots for transactional behavior, then those might be reasons to go through it even for the background writer or checkpointer. But if so, we should be explicit about what the reasons are, both in the mailing list discussion and in code comments. Otherwise I fear that we'll just end up doing something in a more complicated way than is really necessary. -- Robert Haas EDB: http://www.enterprisedb.com ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-16 19:52 Andres Freund <[email protected]> parent: Robert Haas <[email protected]> 1 sibling, 1 reply; 32+ messages in thread From: Andres Freund @ 2022-11-16 19:52 UTC (permalink / raw) To: Robert Haas <[email protected]>; Melanie Plageman <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On 2022-11-16 14:19:32 -0500, Robert Haas wrote: > I have never really understood why we drive background writer or > checkpointer statistics through the statistics collector. To some degree it is required for durability - the stats system needs to know how to write out those stats. But that wasn't ever a good reason to send messages to the stats collector - it could just read the stats from shared memory after all. There's also integration with snapshots of the stats, resetting them, etc. There's also the complexity that some of the stats e.g. for checkpointer aren't about work the checkpointer did, but just have ended up there for historical raisins. E.g. the number of fsyncs and writes done by backends. See below: > Here again, for things like table statistics, there is no choice, because we > could have an unbounded number of tables and need to keep statistics about > all of them. The statistics collector can handle that by allocating more > memory as required. But there is only one background writer and only one > checkpointer, so that is not needed in those cases. Why not just have them > expose anything they want to expose through shared memory directly? That's how it is in 15+. The memory for "fixed-numbered" or "global" statistics are maintained by the stats system, but in plain shared memory, allocated at server start. Not via the hash table. Right now stats updates for the checkpointer use the "changecount" approach to updates. For now that makes sense, because we update the stats only occasionally (after a checkpoint or when writing in CheckpointWriteDelay()) - a stats viewer seeing the checkpoint count go up, without yet seeing the corresponding buffers written would be misleading. I don't think we'd want every buffer write or whatnot go through the changecount mechanism, on some non-x86 platforms that could be noticable. But if we didn't stage the stats updates locally I think we could make most of the stats changes without that overhead. For updates that just increment a single counter there's simply no benefit in the changecount mechanism afaict. I didn't want to do that change during the initial shared memory stats work, it already was bigger than I could handle... It's not quite clear to me what the best path forward is for buf_written_backend / buf_fsync_backend, which currently are reported via the checkpointer stats. I think the best path might be to stop counting them via the CheckpointerShmem->num_backend_writes etc and just populate the fields in the view (for backward compat) via the proposed [1] pg_stat_io patch. Doing that accounting with CheckpointerCommLock held exclusively isn't free. > If the statistics collector provides services that we care about, like > persisting data across restarts or making snapshots for transactional > behavior, then those might be reasons to go through it even for the > background writer or checkpointer. But if so, we should be explicit > about what the reasons are, both in the mailing list discussion and in > code comments. Otherwise I fear that we'll just end up doing something > in a more complicated way than is really necessary. I tried to provide at least some of that in the comments at the start of pgstat.c in 15+. There's very likely more that should be added, but I think it's a decent start. Greetings, Andres Freund [1] https://www.postgresql.org/message-id/CAOtHd0ApHna7_p6mvHoO%2BgLZdxjaQPRemg3_o0a4ytCPijLytQ%40mail.g... ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-17 13:31 Bharath Rupireddy <[email protected]> parent: Robert Haas <[email protected]> 1 sibling, 0 replies; 32+ messages in thread From: Bharath Rupireddy @ 2022-11-17 13:31 UTC (permalink / raw) To: Robert Haas <[email protected]>; +Cc: Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Andres Freund <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> On Thu, Nov 17, 2022 at 12:49 AM Robert Haas <[email protected]> wrote: > > > I also think that a new pg_stat_checkpoint view is needed > > because, right now, the PgStat_CheckpointerStats stats are exposed via > > the pg_stat_bgwriter view, having a separate view for checkpoint stats > > is good here. > > Yep. On Wed, Nov 16, 2022 at 11:44 PM Andres Freund <[email protected]> wrote: > > > I also think that a new pg_stat_checkpoint view is needed > > because, right now, the PgStat_CheckpointerStats stats are exposed via > > the pg_stat_bgwriter view, having a separate view for checkpoint stats > > is good here. > > I agree that we should do that, but largely independent of the architectural > question at hand. Thanks. I quickly prepared a patch introducing pg_stat_checkpointer view and posted it here - https://www.postgresql.org/message-id/CALj2ACVxX2ii%3D66RypXRweZe2EsBRiPMj0aHfRfHUeXJcC7kHg%40mail.g.... -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-17 14:03 Robert Haas <[email protected]> parent: Andres Freund <[email protected]> 0 siblings, 1 reply; 32+ messages in thread From: Robert Haas @ 2022-11-17 14:03 UTC (permalink / raw) To: Andres Freund <[email protected]>; +Cc: Melanie Plageman <[email protected]>; Bharath Rupireddy <[email protected]>; Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> On Wed, Nov 16, 2022 at 2:52 PM Andres Freund <[email protected]> wrote: > I don't think we'd want every buffer write or whatnot go through the > changecount mechanism, on some non-x86 platforms that could be noticable. But > if we didn't stage the stats updates locally I think we could make most of the > stats changes without that overhead. For updates that just increment a single > counter there's simply no benefit in the changecount mechanism afaict. You might be right, but I'm not sure whether it's worth stressing about. The progress reporting mechanism uses the st_changecount mechanism, too, and as far as I know nobody's complained about that having too much overhead. Maybe they have, though, and I've just missed it. -- Robert Haas EDB: http://www.enterprisedb.com ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-17 16:24 Andres Freund <[email protected]> parent: Robert Haas <[email protected]> 0 siblings, 2 replies; 32+ messages in thread From: Andres Freund @ 2022-11-17 16:24 UTC (permalink / raw) To: Robert Haas <[email protected]>; +Cc: Melanie Plageman <[email protected]>; Bharath Rupireddy <[email protected]>; Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On 2022-11-17 09:03:32 -0500, Robert Haas wrote: > On Wed, Nov 16, 2022 at 2:52 PM Andres Freund <[email protected]> wrote: > > I don't think we'd want every buffer write or whatnot go through the > > changecount mechanism, on some non-x86 platforms that could be noticable. But > > if we didn't stage the stats updates locally I think we could make most of the > > stats changes without that overhead. For updates that just increment a single > > counter there's simply no benefit in the changecount mechanism afaict. > > You might be right, but I'm not sure whether it's worth stressing > about. The progress reporting mechanism uses the st_changecount > mechanism, too, and as far as I know nobody's complained about that > having too much overhead. Maybe they have, though, and I've just > missed it. I've seen it in profiles, although not as the major contributor. Most places do a reasonable amount of work between calls though. As an experiment, I added a progress report to BufferSync()'s first loop (i.e. where it checks all buffers). On a 128GB shared_buffers cluster that increases the time for a do-nothing checkpoint from ~235ms to ~280ms. If I remove the changecount stuff and use a single write + write barrier, it ends up as 250ms. Inlining brings it down a bit further, to 247ms. Obviously this is a very extreme case - we only do very little work between the progress report calls. But it does seem to show that the overhead is not entirely neglegible. I think pgstat_progress_start_command() needs the changecount stuff, as does pgstat_progress_update_multi_param(). But for anything updating a single parameter at a time it really doesn't do anything useful on a platform that doesn't tear 64bit writes (so it could be #ifdef PG_HAVE_8BYTE_SINGLE_COPY_ATOMICITY). Out of further curiosity I wanted to test the impact when the loop doesn't even do a LockBufHdr() and added an unlocked pre-check. 109ms without progress. 138ms with. 114ms with the simplified pgstat_progress_update_param(). 108ms after inlining the simplified pgstat_progress_update_param(). Greetings, Andres Freund ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-17 17:18 Tom Lane <[email protected]> parent: Andres Freund <[email protected]> 1 sibling, 0 replies; 32+ messages in thread From: Tom Lane @ 2022-11-17 17:18 UTC (permalink / raw) To: Andres Freund <[email protected]>; +Cc: Robert Haas <[email protected]>; Melanie Plageman <[email protected]>; Bharath Rupireddy <[email protected]>; Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Andres Freund <[email protected]> writes: > I think pgstat_progress_start_command() needs the changecount stuff, as does > pgstat_progress_update_multi_param(). But for anything updating a single > parameter at a time it really doesn't do anything useful on a platform that > doesn't tear 64bit writes (so it could be #ifdef > PG_HAVE_8BYTE_SINGLE_COPY_ATOMICITY). Seems safe to restrict it to that case. regards, tom lane ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-11-17 17:21 Robert Haas <[email protected]> parent: Andres Freund <[email protected]> 1 sibling, 0 replies; 32+ messages in thread From: Robert Haas @ 2022-11-17 17:21 UTC (permalink / raw) To: Andres Freund <[email protected]>; +Cc: Melanie Plageman <[email protected]>; Bharath Rupireddy <[email protected]>; Drouvot, Bertrand <[email protected]>; Nitin Jadhav <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> On Thu, Nov 17, 2022 at 11:24 AM Andres Freund <[email protected]> wrote: > As an experiment, I added a progress report to BufferSync()'s first loop > (i.e. where it checks all buffers). On a 128GB shared_buffers cluster that > increases the time for a do-nothing checkpoint from ~235ms to ~280ms. If I > remove the changecount stuff and use a single write + write barrier, it ends > up as 250ms. Inlining brings it down a bit further, to 247ms. OK, I'd say that's pretty good evidence that we can't totally disregard the issue. -- Robert Haas EDB: http://www.enterprisedb.com ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) @ 2022-12-07 19:03 Andres Freund <[email protected]> parent: Drouvot, Bertrand <[email protected]> 3 siblings, 0 replies; 32+ messages in thread From: Andres Freund @ 2022-12-07 19:03 UTC (permalink / raw) To: Drouvot, Bertrand <[email protected]>; +Cc: Nitin Jadhav <[email protected]>; Bharath Rupireddy <[email protected]>; Matthias van de Meent <[email protected]>; Ashutosh Sharma <[email protected]>; Julien Rouhaud <[email protected]>; Bruce Momjian <[email protected]>; Tom Lane <[email protected]>; Magnus Hagander <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On 2022-11-04 09:25:52 +0100, Drouvot, Bertrand wrote: > Please find attached a rebase in v7. cfbot complains that the docs don't build: https://cirrus-ci.com/task/6694349031866368?logs=docs_build#L296 [03:24:27.317] ref/checkpoint.sgml:66: element para: validity error : Element para is not declared in para list of possible children I've marked the patch as waitin-on-author for now. There's been a bunch of architectural feedback too, but tbh, I don't know if we came to any conclusion on that front... Greetings, Andres Freund ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH 1/3] stress test for repack concurrently @ 2025-12-13 17:13 Mikhail Nikalayeu <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Mikhail Nikalayeu @ 2025-12-13 17:13 UTC (permalink / raw) --- contrib/amcheck/meson.build | 1 + contrib/amcheck/t/007_repack_1.pl | 121 ++++++++++++++++++++++++++++++ doc/src/sgml/regress.sgml | 16 ++++ 3 files changed, 138 insertions(+) create mode 100644 contrib/amcheck/t/007_repack_1.pl diff --git a/contrib/amcheck/meson.build b/contrib/amcheck/meson.build index d5137ef691d..cb4bc32e98a 100644 --- a/contrib/amcheck/meson.build +++ b/contrib/amcheck/meson.build @@ -50,6 +50,7 @@ tests += { 't/004_verify_nbtree_unique.pl', 't/005_pitr.pl', 't/006_verify_gin.pl', + 't/007_repack_1.pl', ], }, } diff --git a/contrib/amcheck/t/007_repack_1.pl b/contrib/amcheck/t/007_repack_1.pl new file mode 100644 index 00000000000..17f3caa3a38 --- /dev/null +++ b/contrib/amcheck/t/007_repack_1.pl @@ -0,0 +1,121 @@ +# Copyright (c) 2021-2026, PostgreSQL Global Development Group + +# Test REPACK CONCURRENTLY with concurrent modifications +use strict; +use warnings FATAL => 'all'; + +use PostgreSQL::Test::Cluster; +use PostgreSQL::Test::Utils; + +use Test::More; + +# PG_TEST_EXTRA carries a numerical stress value; 0 disables the test, +# 1 means the test takes about 6 seconds, and the increase should be +# roughly linear. +my $matched = ($ENV{PG_TEST_EXTRA} // '') =~ /\bstress_concurrently(?:=(?<stressval>[0-9]*))?\b/; +my $stressval = $+{stressval} // 1; +if (!$matched or $stressval == 0) +{ + plan skip_all => 'skipping disabled REPACK CONCURRENTLY stress test'; +} + +note "stressval is $stressval"; + +my $node; + +# Test set-up +$node = PostgreSQL::Test::Cluster->new('CIC_test'); +$node->init; +$node->append_conf('postgresql.conf', + 'lock_timeout = ' . (1000 * $PostgreSQL::Test::Utils::timeout_default)); +$node->append_conf( + 'postgresql.conf', qq( +wal_level = logical +)); + +my $nrows = 10_000 * $stressval; +my $duration = 6 * $stressval; +my $no_hot = int(rand(2)); + +$node->start; +$node->safe_psql('postgres', q(CREATE TABLE tbl(id int PRIMARY KEY, val int))); + +if ($no_hot) +{ + $node->safe_psql('postgres', q(CREATE INDEX test_idx ON tbl(val);)); +} +else +{ + $node->safe_psql('postgres', q(CREATE INDEX test_idx ON tbl(id);)); +} + + +# Load amcheck +$node->safe_psql('postgres', q(CREATE EXTENSION amcheck)); + +# Insert $nrows rows into tbl +$node->safe_psql('postgres', qq( + INSERT INTO tbl SELECT g, g FROM generate_series(1, $nrows) g +)); + +my $sum = $node->safe_psql('postgres', q( + SELECT SUM(val) AS sum FROM tbl +)); + + +$node->pgbench( +"--no-vacuum --client=30 --jobs=4 --exit-on-abort -T $duration", +0, +[qr{actually processed}], +[qr{^$}], +'concurrent operations with REINDEX/CREATE INDEX CONCURRENTLY', +{ + 'concurrent_ops' => qq( + SELECT pg_try_advisory_lock(42)::integer AS gotlock \\gset + \\if :gotlock + REPACK (CONCURRENTLY) tbl USING INDEX tbl_pkey; + SELECT bt_index_parent_check('tbl_pkey', heapallindexed => true); + SELECT bt_index_parent_check('test_idx', heapallindexed => true); + \\sleep 10 ms + + REPACK (CONCURRENTLY) tbl USING INDEX test_idx; + SELECT bt_index_parent_check('tbl_pkey', heapallindexed => true); + SELECT bt_index_parent_check('test_idx', heapallindexed => true); + \\sleep 10 ms + + REPACK (CONCURRENTLY) tbl; + SELECT bt_index_parent_check('tbl_pkey', heapallindexed => true); + SELECT bt_index_parent_check('test_idx', heapallindexed => true); + \\sleep 10 ms + + SELECT pg_advisory_unlock(42); + \\else + \\set num_a random(1, $nrows) + \\set num_b random(1, $nrows) + \\set diff random(1, 10000) + BEGIN; + UPDATE tbl SET val = val + :diff WHERE id = :num_a; + \\sleep 1 ms + UPDATE tbl SET val = val - :diff WHERE id = :num_b; + \\sleep 1 ms + COMMIT; + + BEGIN + --TRANSACTION ISOLATION LEVEL REPEATABLE READ + ; + SELECT 1; + \\sleep 1 ms + SELECT COALESCE(SUM(val), 0) AS sum FROM tbl \\gset p_ + \\if :p_sum != $sum + COMMIT; + SELECT (:p_sum) / 0; + \\endif + + COMMIT; + \\endif + ) +}); + +$node->stop; + +done_testing(); diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml index c74941bfbf2..c5b1b79a60c 100644 --- a/doc/src/sgml/regress.sgml +++ b/doc/src/sgml/regress.sgml @@ -386,6 +386,22 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption' </listitem> </varlistentry> + <varlistentry> + <term><literal>stress_concurrently</literal><optional>=VALUE</optional></term> + <listitem> + <para> + Run some additional, moderately expensive tests for commands with a + <literal>CONCURRENTLY</literal> option. Optionally, an integer can be + given after an equal sign, which affects how long each such test + runs for. + Each test is calibrated so that, when given a value of 10, + it runs for approximately 60 seconds. + If no value is given, 1 is assumed. + Explicitly giving a value of 0 causes the test to be skipped. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><literal>wal_consistency_checking</literal></term> <listitem> -- 2.47.3 --tbdehtstrqwksfdh Content-Type: text/x-diff; charset=utf-8 Content-Disposition: attachment; filename="0002-one-more-stress-test-for-repack-concurrently.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* [PATCH 1/3] stress test for repack concurrently @ 2025-12-13 17:13 Mikhail Nikalayeu <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Mikhail Nikalayeu @ 2025-12-13 17:13 UTC (permalink / raw) --- contrib/amcheck/meson.build | 1 + contrib/amcheck/t/007_repack_1.pl | 121 ++++++++++++++++++++++++++++++ doc/src/sgml/regress.sgml | 16 ++++ 3 files changed, 138 insertions(+) create mode 100644 contrib/amcheck/t/007_repack_1.pl diff --git a/contrib/amcheck/meson.build b/contrib/amcheck/meson.build index d5137ef691d..cb4bc32e98a 100644 --- a/contrib/amcheck/meson.build +++ b/contrib/amcheck/meson.build @@ -50,6 +50,7 @@ tests += { 't/004_verify_nbtree_unique.pl', 't/005_pitr.pl', 't/006_verify_gin.pl', + 't/007_repack_1.pl', ], }, } diff --git a/contrib/amcheck/t/007_repack_1.pl b/contrib/amcheck/t/007_repack_1.pl new file mode 100644 index 00000000000..17f3caa3a38 --- /dev/null +++ b/contrib/amcheck/t/007_repack_1.pl @@ -0,0 +1,121 @@ +# Copyright (c) 2021-2026, PostgreSQL Global Development Group + +# Test REPACK CONCURRENTLY with concurrent modifications +use strict; +use warnings FATAL => 'all'; + +use PostgreSQL::Test::Cluster; +use PostgreSQL::Test::Utils; + +use Test::More; + +# PG_TEST_EXTRA carries a numerical stress value; 0 disables the test, +# 1 means the test takes about 6 seconds, and the increase should be +# roughly linear. +my $matched = ($ENV{PG_TEST_EXTRA} // '') =~ /\bstress_concurrently(?:=(?<stressval>[0-9]*))?\b/; +my $stressval = $+{stressval} // 1; +if (!$matched or $stressval == 0) +{ + plan skip_all => 'skipping disabled REPACK CONCURRENTLY stress test'; +} + +note "stressval is $stressval"; + +my $node; + +# Test set-up +$node = PostgreSQL::Test::Cluster->new('CIC_test'); +$node->init; +$node->append_conf('postgresql.conf', + 'lock_timeout = ' . (1000 * $PostgreSQL::Test::Utils::timeout_default)); +$node->append_conf( + 'postgresql.conf', qq( +wal_level = logical +)); + +my $nrows = 10_000 * $stressval; +my $duration = 6 * $stressval; +my $no_hot = int(rand(2)); + +$node->start; +$node->safe_psql('postgres', q(CREATE TABLE tbl(id int PRIMARY KEY, val int))); + +if ($no_hot) +{ + $node->safe_psql('postgres', q(CREATE INDEX test_idx ON tbl(val);)); +} +else +{ + $node->safe_psql('postgres', q(CREATE INDEX test_idx ON tbl(id);)); +} + + +# Load amcheck +$node->safe_psql('postgres', q(CREATE EXTENSION amcheck)); + +# Insert $nrows rows into tbl +$node->safe_psql('postgres', qq( + INSERT INTO tbl SELECT g, g FROM generate_series(1, $nrows) g +)); + +my $sum = $node->safe_psql('postgres', q( + SELECT SUM(val) AS sum FROM tbl +)); + + +$node->pgbench( +"--no-vacuum --client=30 --jobs=4 --exit-on-abort -T $duration", +0, +[qr{actually processed}], +[qr{^$}], +'concurrent operations with REINDEX/CREATE INDEX CONCURRENTLY', +{ + 'concurrent_ops' => qq( + SELECT pg_try_advisory_lock(42)::integer AS gotlock \\gset + \\if :gotlock + REPACK (CONCURRENTLY) tbl USING INDEX tbl_pkey; + SELECT bt_index_parent_check('tbl_pkey', heapallindexed => true); + SELECT bt_index_parent_check('test_idx', heapallindexed => true); + \\sleep 10 ms + + REPACK (CONCURRENTLY) tbl USING INDEX test_idx; + SELECT bt_index_parent_check('tbl_pkey', heapallindexed => true); + SELECT bt_index_parent_check('test_idx', heapallindexed => true); + \\sleep 10 ms + + REPACK (CONCURRENTLY) tbl; + SELECT bt_index_parent_check('tbl_pkey', heapallindexed => true); + SELECT bt_index_parent_check('test_idx', heapallindexed => true); + \\sleep 10 ms + + SELECT pg_advisory_unlock(42); + \\else + \\set num_a random(1, $nrows) + \\set num_b random(1, $nrows) + \\set diff random(1, 10000) + BEGIN; + UPDATE tbl SET val = val + :diff WHERE id = :num_a; + \\sleep 1 ms + UPDATE tbl SET val = val - :diff WHERE id = :num_b; + \\sleep 1 ms + COMMIT; + + BEGIN + --TRANSACTION ISOLATION LEVEL REPEATABLE READ + ; + SELECT 1; + \\sleep 1 ms + SELECT COALESCE(SUM(val), 0) AS sum FROM tbl \\gset p_ + \\if :p_sum != $sum + COMMIT; + SELECT (:p_sum) / 0; + \\endif + + COMMIT; + \\endif + ) +}); + +$node->stop; + +done_testing(); diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml index c74941bfbf2..c5b1b79a60c 100644 --- a/doc/src/sgml/regress.sgml +++ b/doc/src/sgml/regress.sgml @@ -386,6 +386,22 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption' </listitem> </varlistentry> + <varlistentry> + <term><literal>stress_concurrently</literal><optional>=VALUE</optional></term> + <listitem> + <para> + Run some additional, moderately expensive tests for commands with a + <literal>CONCURRENTLY</literal> option. Optionally, an integer can be + given after an equal sign, which affects how long each such test + runs for. + Each test is calibrated so that, when given a value of 10, + it runs for approximately 60 seconds. + If no value is given, 1 is assumed. + Explicitly giving a value of 0 causes the test to be skipped. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><literal>wal_consistency_checking</literal></term> <listitem> -- 2.47.3 --tbdehtstrqwksfdh Content-Type: text/x-diff; charset=utf-8 Content-Disposition: attachment; filename="0002-one-more-stress-test-for-repack-concurrently.patch" ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: [PATCH] check kernel version for io_method @ 2026-01-14 11:14 Jakub Wartak <[email protected]> 0 siblings, 1 reply; 32+ messages in thread From: Jakub Wartak @ 2026-01-14 11:14 UTC (permalink / raw) To: Steven Niu <[email protected]>; +Cc: Andreas Karlsson <[email protected]>; Pierre <[email protected]>; [email protected] <[email protected]> On Wed, Jan 14, 2026 at 3:31 AM Steven Niu <[email protected]> wrote: > > From: Andreas Karlsson <[email protected]> > Sent: Wednesday, January 14, 2026 09:07 > To: Pierre <[email protected]>; [email protected] <[email protected]> > Subject: Re: [PATCH] check kernel version for io_method > > > On 1/13/26 11:05 PM, Pierre wrote: > > Please find a patch proposal for bug BUG #19369: Not documented that > > io_uring on kernel versions between 5.1 and below 5.6 does not work. > Wouldn't it make more sense to use io_uring_get_probe_ring() and > io_uring_opcode_supported() to actually check for the required opcode? > Then if someone uses a Kernel with the required features backported > everything will still work. > > Andreas > > +1 > It would be more reliable to check the availability of io_uring feature than to check OS version. > Hi, I haven't looked at this patch, however the above statement is not completely true. There is a parallel problem [1] related to kernel version, where if you do not run proper kernel version (>= 6.5) or proper liburing version, then fork() (-> all connections established) are going to be slow slugging under more than basic load due to lack of "combined memory mapping creation" (so technically speaking recommending someone to go to 5.6.x but < 6.5 IMHO is also not good advice). See first message in that [1] for a performance report about this. IMHVO if we are checking for kernel versions we could also warn about performance regression (something like merge those two patches if one wants to have a good io_uring experience). -J. [1] - https://www.postgresql.org/message-id/CAKZiRmzxj6Lt1w2ffDoUmN533TgyDeYVULEH1PQFLRyBJSFP6w%40mail.gma... ^ permalink raw reply [nested|flat] 32+ messages in thread
* Re: [PATCH] check kernel version for io_method @ 2026-01-14 17:26 Andreas Karlsson <[email protected]> parent: Jakub Wartak <[email protected]> 0 siblings, 0 replies; 32+ messages in thread From: Andreas Karlsson @ 2026-01-14 17:26 UTC (permalink / raw) To: Jakub Wartak <[email protected]>; Steven Niu <[email protected]>; +Cc: Pierre <[email protected]>; [email protected] <[email protected]> On 1/14/26 12:14 PM, Jakub Wartak wrote: > I haven't looked at this patch, however the above statement is not > completely true. There is a parallel problem [1] related to kernel > version, where if you do not run proper kernel version (>= 6.5) or > proper liburing version, then fork() (-> all connections established) > are going to be slow slugging under more than basic load due to lack > of "combined memory mapping creation" (so technically speaking > recommending someone to go to 5.6.x but < 6.5 IMHO is also not good > advice). See first message in that [1] for a performance report about > this. IMHVO if we are checking for kernel versions we could also warn > about performance regression (something like merge those two patches > if one wants to have a good io_uring experience). We can probe for that too, which we already do. If you call pgaio_uring_ring_shmem_size() it will return 0 on Linux <6.5. Which I think eve further supports probing for the features we need rather than looking at the kernel version. Andreas ^ permalink raw reply [nested|flat] 32+ messages in thread
end of thread, other threads:[~2026-01-14 17:26 UTC | newest] Thread overview: 32+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2019-09-05 11:21 [PATCH v11 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2019-09-05 11:21 [PATCH v5 1/3] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2019-09-05 11:21 [PATCH v7 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2019-09-05 11:21 [PATCH v12 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2019-09-05 11:21 [PATCH v7 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2019-09-05 11:21 [PATCH v6 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2019-09-05 11:21 [PATCH v9 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2019-09-05 11:21 [PATCH v8 1/4] Move callback-call from ReadPageInternal to XLogReadRecord. Kyotaro Horiguchi <[email protected]> 2022-04-05 09:45 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Michael Paquier <[email protected]> 2022-06-13 13:56 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Nitin Jadhav <[email protected]> 2022-06-06 06:03 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Nitin Jadhav <[email protected]> 2022-06-13 13:38 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Nitin Jadhav <[email protected]> 2022-07-07 00:04 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Andres Freund <[email protected]> 2022-07-28 09:38 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Nitin Jadhav <[email protected]> 2022-11-04 08:25 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Drouvot, Bertrand <[email protected]> 2022-11-15 11:41 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Nitin Jadhav <[email protected]> 2022-11-15 20:04 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Robert Haas <[email protected]> 2022-11-16 10:31 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Bharath Rupireddy <[email protected]> 2022-11-16 18:14 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Andres Freund <[email protected]> 2022-11-16 19:19 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Robert Haas <[email protected]> 2022-11-16 19:52 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Andres Freund <[email protected]> 2022-11-17 14:03 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Robert Haas <[email protected]> 2022-11-17 16:24 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Andres Freund <[email protected]> 2022-11-17 17:18 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Tom Lane <[email protected]> 2022-11-17 17:21 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Robert Haas <[email protected]> 2022-11-17 13:31 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Bharath Rupireddy <[email protected]> 2022-11-15 20:18 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Andres Freund <[email protected]> 2022-12-07 19:03 ` Re: Report checkpoint progress with pg_stat_progress_checkpoint (was: Report checkpoint progress in server logs) Andres Freund <[email protected]> 2025-12-13 17:13 [PATCH 1/3] stress test for repack concurrently Mikhail Nikalayeu <[email protected]> 2025-12-13 17:13 [PATCH 1/3] stress test for repack concurrently Mikhail Nikalayeu <[email protected]> 2026-01-14 11:14 Re: [PATCH] check kernel version for io_method Jakub Wartak <[email protected]> 2026-01-14 17:26 ` Re: [PATCH] check kernel version for io_method Andreas Karlsson <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox