LCOV - code coverage report
Current view: top level - src/bin/pg_waldump - pg_waldump.c (source / functions) Coverage Total Hit
Test: PostgreSQL 19devel Lines: 84.4 % 533 450
Test Date: 2026-03-10 12:14:48 Functions: 94.7 % 19 18
Legend: Lines:     hit not hit

            Line data    Source code
       1              : /*-------------------------------------------------------------------------
       2              :  *
       3              :  * pg_waldump.c - decode and display WAL
       4              :  *
       5              :  * Copyright (c) 2013-2026, PostgreSQL Global Development Group
       6              :  *
       7              :  * IDENTIFICATION
       8              :  *        src/bin/pg_waldump/pg_waldump.c
       9              :  *-------------------------------------------------------------------------
      10              :  */
      11              : 
      12              : #define FRONTEND 1
      13              : #include "postgres.h"
      14              : 
      15              : #include <dirent.h>
      16              : #include <limits.h>
      17              : #include <signal.h>
      18              : #include <sys/stat.h>
      19              : #include <unistd.h>
      20              : 
      21              : #include "access/transam.h"
      22              : #include "access/xlog_internal.h"
      23              : #include "access/xlogreader.h"
      24              : #include "access/xlogrecord.h"
      25              : #include "access/xlogstats.h"
      26              : #include "common/fe_memutils.h"
      27              : #include "common/file_perm.h"
      28              : #include "common/file_utils.h"
      29              : #include "common/logging.h"
      30              : #include "common/relpath.h"
      31              : #include "getopt_long.h"
      32              : #include "rmgrdesc.h"
      33              : #include "storage/bufpage.h"
      34              : 
      35              : /*
      36              :  * NOTE: For any code change or issue fix here, it is highly recommended to
      37              :  * give a thought about doing the same in pg_walinspect contrib module as well.
      38              :  */
      39              : 
      40              : static const char *progname;
      41              : 
      42              : static volatile sig_atomic_t time_to_stop = false;
      43              : 
      44              : static const RelFileLocator emptyRelFileLocator = {0, 0, 0};
      45              : 
      46              : typedef struct XLogDumpPrivate
      47              : {
      48              :     TimeLineID  timeline;
      49              :     XLogRecPtr  startptr;
      50              :     XLogRecPtr  endptr;
      51              :     bool        endptr_reached;
      52              : } XLogDumpPrivate;
      53              : 
      54              : typedef struct XLogDumpConfig
      55              : {
      56              :     /* display options */
      57              :     bool        quiet;
      58              :     bool        bkp_details;
      59              :     int         stop_after_records;
      60              :     int         already_displayed_records;
      61              :     bool        follow;
      62              :     bool        stats;
      63              :     bool        stats_per_record;
      64              : 
      65              :     /* filter options */
      66              :     bool        filter_by_rmgr[RM_MAX_ID + 1];
      67              :     bool        filter_by_rmgr_enabled;
      68              :     TransactionId filter_by_xid;
      69              :     bool        filter_by_xid_enabled;
      70              :     RelFileLocator filter_by_relation;
      71              :     bool        filter_by_extended;
      72              :     bool        filter_by_relation_enabled;
      73              :     BlockNumber filter_by_relation_block;
      74              :     bool        filter_by_relation_block_enabled;
      75              :     ForkNumber  filter_by_relation_forknum;
      76              :     bool        filter_by_fpw;
      77              : 
      78              :     /* save options */
      79              :     char       *save_fullpage_path;
      80              : } XLogDumpConfig;
      81              : 
      82              : 
      83              : /*
      84              :  * When sigint is called, just tell the system to exit at the next possible
      85              :  * moment.
      86              :  */
      87              : #ifndef WIN32
      88              : 
      89              : static void
      90            0 : sigint_handler(SIGNAL_ARGS)
      91              : {
      92            0 :     time_to_stop = true;
      93            0 : }
      94              : #endif
      95              : 
      96              : static void
      97            1 : print_rmgr_list(void)
      98              : {
      99              :     int         i;
     100              : 
     101           23 :     for (i = 0; i <= RM_MAX_BUILTIN_ID; i++)
     102              :     {
     103           22 :         printf("%s\n", GetRmgrDesc(i)->rm_name);
     104              :     }
     105            1 : }
     106              : 
     107              : /*
     108              :  * Check whether directory exists and whether we can open it. Keep errno set so
     109              :  * that the caller can report errors somewhat more accurately.
     110              :  */
     111              : static bool
     112           69 : verify_directory(const char *directory)
     113              : {
     114           69 :     DIR        *dir = opendir(directory);
     115              : 
     116           69 :     if (dir == NULL)
     117            1 :         return false;
     118           68 :     closedir(dir);
     119           68 :     return true;
     120              : }
     121              : 
     122              : /*
     123              :  * Create if necessary the directory storing the full-page images extracted
     124              :  * from the WAL records read.
     125              :  */
     126              : static void
     127            1 : create_fullpage_directory(char *path)
     128              : {
     129              :     int         ret;
     130              : 
     131            1 :     switch ((ret = pg_check_dir(path)))
     132              :     {
     133            1 :         case 0:
     134              :             /* Does not exist, so create it */
     135            1 :             if (pg_mkdir_p(path, pg_dir_create_mode) < 0)
     136            0 :                 pg_fatal("could not create directory \"%s\": %m", path);
     137            1 :             break;
     138            0 :         case 1:
     139              :             /* Present and empty, so do nothing */
     140            0 :             break;
     141            0 :         case 2:
     142              :         case 3:
     143              :         case 4:
     144              :             /* Exists and not empty */
     145            0 :             pg_fatal("directory \"%s\" exists but is not empty", path);
     146              :             break;
     147            0 :         default:
     148              :             /* Trouble accessing directory */
     149            0 :             pg_fatal("could not access directory \"%s\": %m", path);
     150              :     }
     151            1 : }
     152              : 
     153              : /*
     154              :  * Split a pathname as dirname(1) and basename(1) would.
     155              :  *
     156              :  * XXX this probably doesn't do very well on Windows.  We probably need to
     157              :  * apply canonicalize_path(), at the very least.
     158              :  */
     159              : static void
     160            9 : split_path(const char *path, char **dir, char **fname)
     161              : {
     162              :     const char *sep;
     163              : 
     164              :     /* split filepath into directory & filename */
     165            9 :     sep = strrchr(path, '/');
     166              : 
     167              :     /* directory path */
     168            9 :     if (sep != NULL)
     169              :     {
     170            7 :         *dir = pnstrdup(path, sep - path);
     171            7 :         *fname = pg_strdup(sep + 1);
     172              :     }
     173              :     /* local directory */
     174              :     else
     175              :     {
     176            2 :         *dir = NULL;
     177            2 :         *fname = pg_strdup(path);
     178              :     }
     179            9 : }
     180              : 
     181              : /*
     182              :  * Open the file in the valid target directory.
     183              :  *
     184              :  * return a read only fd
     185              :  */
     186              : static int
     187          145 : open_file_in_directory(const char *directory, const char *fname)
     188              : {
     189          145 :     int         fd = -1;
     190              :     char        fpath[MAXPGPATH];
     191              : 
     192              :     Assert(directory != NULL);
     193              : 
     194          145 :     snprintf(fpath, MAXPGPATH, "%s/%s", directory, fname);
     195          145 :     fd = open(fpath, O_RDONLY | PG_BINARY, 0);
     196              : 
     197          145 :     if (fd < 0 && errno != ENOENT)
     198            0 :         pg_fatal("could not open file \"%s\": %m", fname);
     199          145 :     return fd;
     200              : }
     201              : 
     202              : /*
     203              :  * Try to find fname in the given directory. Returns true if it is found,
     204              :  * false otherwise. If fname is NULL, search the complete directory for any
     205              :  * file with a valid WAL file name. If file is successfully opened, set
     206              :  * *WaSegSz to the WAL segment size.
     207              :  */
     208              : static bool
     209           83 : search_directory(const char *directory, const char *fname, int *WalSegSz)
     210              : {
     211           83 :     int         fd = -1;
     212              :     DIR        *xldir;
     213              : 
     214              :     /* open file if valid filename is provided */
     215           83 :     if (fname != NULL)
     216            8 :         fd = open_file_in_directory(directory, fname);
     217              : 
     218              :     /*
     219              :      * A valid file name is not passed, so search the complete directory.  If
     220              :      * we find any file whose name is a valid WAL file name then try to open
     221              :      * it.  If we cannot open it, bail out.
     222              :      */
     223           75 :     else if ((xldir = opendir(directory)) != NULL)
     224              :     {
     225              :         struct dirent *xlde;
     226              : 
     227          554 :         while ((xlde = readdir(xldir)) != NULL)
     228              :         {
     229          541 :             if (IsXLogFileName(xlde->d_name))
     230              :             {
     231           62 :                 fd = open_file_in_directory(directory, xlde->d_name);
     232           62 :                 fname = pg_strdup(xlde->d_name);
     233           62 :                 break;
     234              :             }
     235              :         }
     236              : 
     237           75 :         closedir(xldir);
     238              :     }
     239              : 
     240              :     /* set WalSegSz if file is successfully opened */
     241           83 :     if (fd >= 0)
     242              :     {
     243              :         PGAlignedXLogBlock buf;
     244              :         int         r;
     245              : 
     246           68 :         r = read(fd, buf.data, XLOG_BLCKSZ);
     247           68 :         if (r == XLOG_BLCKSZ)
     248              :         {
     249           68 :             XLogLongPageHeader longhdr = (XLogLongPageHeader) buf.data;
     250              : 
     251           68 :             if (!IsValidWalSegSize(longhdr->xlp_seg_size))
     252              :             {
     253            1 :                 pg_log_error(ngettext("invalid WAL segment size in WAL file \"%s\" (%d byte)",
     254              :                                       "invalid WAL segment size in WAL file \"%s\" (%d bytes)",
     255              :                                       longhdr->xlp_seg_size),
     256              :                              fname, longhdr->xlp_seg_size);
     257            1 :                 pg_log_error_detail("The WAL segment size must be a power of two between 1 MB and 1 GB.");
     258            1 :                 exit(1);
     259              :             }
     260              : 
     261           67 :             *WalSegSz = longhdr->xlp_seg_size;
     262              :         }
     263            0 :         else if (r < 0)
     264            0 :             pg_fatal("could not read file \"%s\": %m",
     265              :                      fname);
     266              :         else
     267            0 :             pg_fatal("could not read file \"%s\": read %d of %d",
     268              :                      fname, r, XLOG_BLCKSZ);
     269           67 :         close(fd);
     270           67 :         return true;
     271              :     }
     272              : 
     273           15 :     return false;
     274              : }
     275              : 
     276              : /*
     277              :  * Identify the target directory.
     278              :  *
     279              :  * Try to find the file in several places:
     280              :  * if directory != NULL:
     281              :  *   directory /
     282              :  *   directory / XLOGDIR /
     283              :  * else
     284              :  *   .
     285              :  *   XLOGDIR /
     286              :  *   $PGDATA / XLOGDIR /
     287              :  *
     288              :  * The valid target directory is returned, and *WalSegSz is set to the
     289              :  * size of the WAL segment found in that directory.
     290              :  */
     291              : static char *
     292           69 : identify_target_directory(char *directory, char *fname, int *WalSegSz)
     293              : {
     294              :     char        fpath[MAXPGPATH];
     295              : 
     296           69 :     if (directory != NULL)
     297              :     {
     298           68 :         if (search_directory(directory, fname, WalSegSz))
     299           54 :             return pg_strdup(directory);
     300              : 
     301              :         /* directory / XLOGDIR */
     302           13 :         snprintf(fpath, MAXPGPATH, "%s/%s", directory, XLOGDIR);
     303           13 :         if (search_directory(fpath, fname, WalSegSz))
     304           13 :             return pg_strdup(fpath);
     305              :     }
     306              :     else
     307              :     {
     308              :         const char *datadir;
     309              : 
     310              :         /* current directory */
     311            1 :         if (search_directory(".", fname, WalSegSz))
     312            0 :             return pg_strdup(".");
     313              :         /* XLOGDIR */
     314            1 :         if (search_directory(XLOGDIR, fname, WalSegSz))
     315            0 :             return pg_strdup(XLOGDIR);
     316              : 
     317            1 :         datadir = getenv("PGDATA");
     318              :         /* $PGDATA / XLOGDIR */
     319            1 :         if (datadir != NULL)
     320              :         {
     321            0 :             snprintf(fpath, MAXPGPATH, "%s/%s", datadir, XLOGDIR);
     322            0 :             if (search_directory(fpath, fname, WalSegSz))
     323            0 :                 return pg_strdup(fpath);
     324              :         }
     325              :     }
     326              : 
     327              :     /* could not locate WAL file */
     328            1 :     if (fname)
     329            1 :         pg_fatal("could not locate WAL file \"%s\"", fname);
     330              :     else
     331            0 :         pg_fatal("could not find any WAL file");
     332              : 
     333              :     return NULL;                /* not reached */
     334              : }
     335              : 
     336              : /* pg_waldump's XLogReaderRoutine->segment_open callback */
     337              : static void
     338           67 : WALDumpOpenSegment(XLogReaderState *state, XLogSegNo nextSegNo,
     339              :                    TimeLineID *tli_p)
     340              : {
     341           67 :     TimeLineID  tli = *tli_p;
     342              :     char        fname[MAXPGPATH];
     343              :     int         tries;
     344              : 
     345           67 :     XLogFileName(fname, tli, nextSegNo, state->segcxt.ws_segsize);
     346              : 
     347              :     /*
     348              :      * In follow mode there is a short period of time after the server has
     349              :      * written the end of the previous file before the new file is available.
     350              :      * So we loop for 5 seconds looking for the file to appear before giving
     351              :      * up.
     352              :      */
     353           67 :     for (tries = 0; tries < 10; tries++)
     354              :     {
     355           67 :         state->seg.ws_file = open_file_in_directory(state->segcxt.ws_dir, fname);
     356           67 :         if (state->seg.ws_file >= 0)
     357           67 :             return;
     358            0 :         if (errno == ENOENT)
     359            0 :         {
     360            0 :             int         save_errno = errno;
     361              : 
     362              :             /* File not there yet, try again */
     363            0 :             pg_usleep(500 * 1000);
     364              : 
     365            0 :             errno = save_errno;
     366            0 :             continue;
     367              :         }
     368              :         /* Any other error, fall through and fail */
     369            0 :         break;
     370              :     }
     371              : 
     372            0 :     pg_fatal("could not find file \"%s\": %m", fname);
     373              : }
     374              : 
     375              : /*
     376              :  * pg_waldump's XLogReaderRoutine->segment_close callback.  Same as
     377              :  * wal_segment_close
     378              :  */
     379              : static void
     380           65 : WALDumpCloseSegment(XLogReaderState *state)
     381              : {
     382           65 :     close(state->seg.ws_file);
     383              :     /* need to check errno? */
     384           65 :     state->seg.ws_file = -1;
     385           65 : }
     386              : 
     387              : /* pg_waldump's XLogReaderRoutine->page_read callback */
     388              : static int
     389        18490 : WALDumpReadPage(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen,
     390              :                 XLogRecPtr targetPtr, char *readBuff)
     391              : {
     392        18490 :     XLogDumpPrivate *private = state->private_data;
     393        18490 :     int         count = XLOG_BLCKSZ;
     394              :     WALReadError errinfo;
     395              : 
     396        18490 :     if (XLogRecPtrIsValid(private->endptr))
     397              :     {
     398        16536 :         if (targetPagePtr + XLOG_BLCKSZ <= private->endptr)
     399        16417 :             count = XLOG_BLCKSZ;
     400          119 :         else if (targetPagePtr + reqLen <= private->endptr)
     401           57 :             count = private->endptr - targetPagePtr;
     402              :         else
     403              :         {
     404           62 :             private->endptr_reached = true;
     405           62 :             return -1;
     406              :         }
     407              :     }
     408              : 
     409        18428 :     if (!WALRead(state, readBuff, targetPagePtr, count, private->timeline,
     410              :                  &errinfo))
     411              :     {
     412            0 :         WALOpenSegment *seg = &errinfo.wre_seg;
     413              :         char        fname[MAXPGPATH];
     414              : 
     415            0 :         XLogFileName(fname, seg->ws_tli, seg->ws_segno,
     416              :                      state->segcxt.ws_segsize);
     417              : 
     418            0 :         if (errinfo.wre_errno != 0)
     419              :         {
     420            0 :             errno = errinfo.wre_errno;
     421            0 :             pg_fatal("could not read from file \"%s\", offset %d: %m",
     422              :                      fname, errinfo.wre_off);
     423              :         }
     424              :         else
     425            0 :             pg_fatal("could not read from file \"%s\", offset %d: read %d of %d",
     426              :                      fname, errinfo.wre_off, errinfo.wre_read,
     427              :                      errinfo.wre_req);
     428              :     }
     429              : 
     430        18428 :     return count;
     431              : }
     432              : 
     433              : /*
     434              :  * Boolean to return whether the given WAL record matches a specific relation
     435              :  * and optionally block.
     436              :  */
     437              : static bool
     438       128057 : XLogRecordMatchesRelationBlock(XLogReaderState *record,
     439              :                                RelFileLocator matchRlocator,
     440              :                                BlockNumber matchBlock,
     441              :                                ForkNumber matchFork)
     442              : {
     443              :     int         block_id;
     444              : 
     445       269807 :     for (block_id = 0; block_id <= XLogRecMaxBlockId(record); block_id++)
     446              :     {
     447              :         RelFileLocator rlocator;
     448              :         ForkNumber  forknum;
     449              :         BlockNumber blk;
     450              : 
     451       141958 :         if (!XLogRecGetBlockTagExtended(record, block_id,
     452              :                                         &rlocator, &forknum, &blk, NULL))
     453           36 :             continue;
     454              : 
     455       141922 :         if ((matchFork == InvalidForkNumber || matchFork == forknum) &&
     456       102780 :             (RelFileLocatorEquals(matchRlocator, emptyRelFileLocator) ||
     457       102780 :              RelFileLocatorEquals(matchRlocator, rlocator)) &&
     458            4 :             (matchBlock == InvalidBlockNumber || matchBlock == blk))
     459          208 :             return true;
     460              :     }
     461              : 
     462       127849 :     return false;
     463              : }
     464              : 
     465              : /*
     466              :  * Boolean to return whether the given WAL record contains a full page write.
     467              :  */
     468              : static bool
     469        34464 : XLogRecordHasFPW(XLogReaderState *record)
     470              : {
     471              :     int         block_id;
     472              : 
     473        72525 :     for (block_id = 0; block_id <= XLogRecMaxBlockId(record); block_id++)
     474              :     {
     475        39132 :         if (!XLogRecHasBlockRef(record, block_id))
     476            7 :             continue;
     477              : 
     478        39125 :         if (XLogRecHasBlockImage(record, block_id))
     479         1071 :             return true;
     480              :     }
     481              : 
     482        33393 :     return false;
     483              : }
     484              : 
     485              : /*
     486              :  * Function to externally save all FPWs stored in the given WAL record.
     487              :  * Decompression is applied to all the blocks saved, if necessary.
     488              :  */
     489              : static void
     490          201 : XLogRecordSaveFPWs(XLogReaderState *record, const char *savepath)
     491              : {
     492              :     int         block_id;
     493              : 
     494          402 :     for (block_id = 0; block_id <= XLogRecMaxBlockId(record); block_id++)
     495              :     {
     496              :         PGAlignedBlock buf;
     497              :         Page        page;
     498              :         char        filename[MAXPGPATH];
     499              :         char        forkname[FORKNAMECHARS + 2];    /* _ + terminating zero */
     500              :         FILE       *file;
     501              :         BlockNumber blk;
     502              :         RelFileLocator rnode;
     503              :         ForkNumber  fork;
     504              : 
     505          201 :         if (!XLogRecHasBlockRef(record, block_id))
     506          200 :             continue;
     507              : 
     508          201 :         if (!XLogRecHasBlockImage(record, block_id))
     509          200 :             continue;
     510              : 
     511            1 :         page = (Page) buf.data;
     512              : 
     513              :         /* Full page exists, so let's save it */
     514            1 :         if (!RestoreBlockImage(record, block_id, page))
     515            0 :             pg_fatal("%s", record->errormsg_buf);
     516              : 
     517            1 :         (void) XLogRecGetBlockTagExtended(record, block_id,
     518              :                                           &rnode, &fork, &blk, NULL);
     519              : 
     520            1 :         if (fork >= 0 && fork <= MAX_FORKNUM)
     521            1 :             sprintf(forkname, "_%s", forkNames[fork]);
     522              :         else
     523            0 :             pg_fatal("invalid fork number: %u", fork);
     524              : 
     525            1 :         snprintf(filename, MAXPGPATH, "%s/%08X-%08X-%08X.%u.%u.%u.%u%s", savepath,
     526              :                  record->seg.ws_tli,
     527            1 :                  LSN_FORMAT_ARGS(record->ReadRecPtr),
     528              :                  rnode.spcOid, rnode.dbOid, rnode.relNumber, blk, forkname);
     529              : 
     530            1 :         file = fopen(filename, PG_BINARY_W);
     531            1 :         if (!file)
     532            0 :             pg_fatal("could not open file \"%s\": %m", filename);
     533              : 
     534            1 :         if (fwrite(page, BLCKSZ, 1, file) != 1)
     535            0 :             pg_fatal("could not write file \"%s\": %m", filename);
     536              : 
     537            1 :         if (fclose(file) != 0)
     538            0 :             pg_fatal("could not close file \"%s\": %m", filename);
     539              :     }
     540          201 : }
     541              : 
     542              : /*
     543              :  * Print a record to stdout
     544              :  */
     545              : static void
     546       257703 : XLogDumpDisplayRecord(XLogDumpConfig *config, XLogReaderState *record)
     547              : {
     548              :     const char *id;
     549       257703 :     const RmgrDescData *desc = GetRmgrDesc(XLogRecGetRmid(record));
     550              :     uint32      rec_len;
     551              :     uint32      fpi_len;
     552       257703 :     uint8       info = XLogRecGetInfo(record);
     553       257703 :     XLogRecPtr  xl_prev = XLogRecGetPrev(record);
     554              :     StringInfoData s;
     555              : 
     556       257703 :     XLogRecGetLen(record, &rec_len, &fpi_len);
     557              : 
     558       257703 :     printf("rmgr: %-11s len (rec/tot): %6u/%6u, tx: %10u, lsn: %X/%08X, prev %X/%08X, ",
     559              :            desc->rm_name,
     560              :            rec_len, XLogRecGetTotalLen(record),
     561              :            XLogRecGetXid(record),
     562              :            LSN_FORMAT_ARGS(record->ReadRecPtr),
     563              :            LSN_FORMAT_ARGS(xl_prev));
     564              : 
     565       257703 :     id = desc->rm_identify(info);
     566       257703 :     if (id == NULL)
     567            0 :         printf("desc: UNKNOWN (%x) ", info & ~XLR_INFO_MASK);
     568              :     else
     569       257703 :         printf("desc: %s ", id);
     570              : 
     571       257703 :     initStringInfo(&s);
     572       257703 :     desc->rm_desc(&s, record);
     573       257703 :     printf("%s", s.data);
     574              : 
     575       257703 :     resetStringInfo(&s);
     576       257703 :     XLogRecGetBlockRefInfo(record, true, config->bkp_details, &s, NULL);
     577       257703 :     printf("%s", s.data);
     578       257703 :     pfree(s.data);
     579       257703 : }
     580              : 
     581              : /*
     582              :  * Display a single row of record counts and sizes for an rmgr or record.
     583              :  */
     584              : static void
     585           79 : XLogDumpStatsRow(const char *name,
     586              :                  uint64 n, uint64 total_count,
     587              :                  uint64 rec_len, uint64 total_rec_len,
     588              :                  uint64 fpi_len, uint64 total_fpi_len,
     589              :                  uint64 tot_len, uint64 total_len)
     590              : {
     591              :     double      n_pct,
     592              :                 rec_len_pct,
     593              :                 fpi_len_pct,
     594              :                 tot_len_pct;
     595              : 
     596           79 :     n_pct = 0;
     597           79 :     if (total_count != 0)
     598           79 :         n_pct = 100 * (double) n / total_count;
     599              : 
     600           79 :     rec_len_pct = 0;
     601           79 :     if (total_rec_len != 0)
     602           79 :         rec_len_pct = 100 * (double) rec_len / total_rec_len;
     603              : 
     604           79 :     fpi_len_pct = 0;
     605           79 :     if (total_fpi_len != 0)
     606           79 :         fpi_len_pct = 100 * (double) fpi_len / total_fpi_len;
     607              : 
     608           79 :     tot_len_pct = 0;
     609           79 :     if (total_len != 0)
     610           79 :         tot_len_pct = 100 * (double) tot_len / total_len;
     611              : 
     612           79 :     printf("%-27s "
     613              :            "%20" PRIu64 " (%6.02f) "
     614              :            "%20" PRIu64 " (%6.02f) "
     615              :            "%20" PRIu64 " (%6.02f) "
     616              :            "%20" PRIu64 " (%6.02f)\n",
     617              :            name, n, n_pct, rec_len, rec_len_pct, fpi_len, fpi_len_pct,
     618              :            tot_len, tot_len_pct);
     619           79 : }
     620              : 
     621              : 
     622              : /*
     623              :  * Display summary statistics about the records seen so far.
     624              :  */
     625              : static void
     626            2 : XLogDumpDisplayStats(XLogDumpConfig *config, XLogStats *stats)
     627              : {
     628              :     int         ri,
     629              :                 rj;
     630            2 :     uint64      total_count = 0;
     631            2 :     uint64      total_rec_len = 0;
     632            2 :     uint64      total_fpi_len = 0;
     633            2 :     uint64      total_len = 0;
     634              :     double      rec_len_pct,
     635              :                 fpi_len_pct;
     636              : 
     637              :     /*
     638              :      * Leave if no stats have been computed yet, as tracked by the end LSN.
     639              :      */
     640            2 :     if (!XLogRecPtrIsValid(stats->endptr))
     641            0 :         return;
     642              : 
     643              :     /*
     644              :      * Each row shows its percentages of the total, so make a first pass to
     645              :      * calculate column totals.
     646              :      */
     647              : 
     648          514 :     for (ri = 0; ri <= RM_MAX_ID; ri++)
     649              :     {
     650          512 :         if (!RmgrIdIsValid(ri))
     651          212 :             continue;
     652              : 
     653          300 :         total_count += stats->rmgr_stats[ri].count;
     654          300 :         total_rec_len += stats->rmgr_stats[ri].rec_len;
     655          300 :         total_fpi_len += stats->rmgr_stats[ri].fpi_len;
     656              :     }
     657            2 :     total_len = total_rec_len + total_fpi_len;
     658              : 
     659            2 :     printf("WAL statistics between %X/%08X and %X/%08X:\n",
     660              :            LSN_FORMAT_ARGS(stats->startptr), LSN_FORMAT_ARGS(stats->endptr));
     661              : 
     662              :     /*
     663              :      * 27 is strlen("Transaction/COMMIT_PREPARED"), 20 is strlen(2^64), 8 is
     664              :      * strlen("(100.00%)")
     665              :      */
     666              : 
     667            2 :     printf("%-27s %20s %8s %20s %8s %20s %8s %20s %8s\n"
     668              :            "%-27s %20s %8s %20s %8s %20s %8s %20s %8s\n",
     669              :            "Type", "N", "(%)", "Record size", "(%)", "FPI size", "(%)", "Combined size", "(%)",
     670              :            "----", "-", "---", "-----------", "---", "--------", "---", "-------------", "---");
     671              : 
     672          514 :     for (ri = 0; ri <= RM_MAX_ID; ri++)
     673              :     {
     674              :         uint64      count,
     675              :                     rec_len,
     676              :                     fpi_len,
     677              :                     tot_len;
     678              :         const RmgrDescData *desc;
     679              : 
     680          512 :         if (!RmgrIdIsValid(ri))
     681          212 :             continue;
     682              : 
     683          300 :         desc = GetRmgrDesc(ri);
     684              : 
     685          300 :         if (!config->stats_per_record)
     686              :         {
     687          150 :             count = stats->rmgr_stats[ri].count;
     688          150 :             rec_len = stats->rmgr_stats[ri].rec_len;
     689          150 :             fpi_len = stats->rmgr_stats[ri].fpi_len;
     690          150 :             tot_len = rec_len + fpi_len;
     691              : 
     692          150 :             if (RmgrIdIsCustom(ri) && count == 0)
     693          128 :                 continue;
     694              : 
     695           22 :             XLogDumpStatsRow(desc->rm_name,
     696              :                              count, total_count, rec_len, total_rec_len,
     697              :                              fpi_len, total_fpi_len, tot_len, total_len);
     698              :         }
     699              :         else
     700              :         {
     701         2550 :             for (rj = 0; rj < MAX_XLINFO_TYPES; rj++)
     702              :             {
     703              :                 const char *id;
     704              : 
     705         2400 :                 count = stats->record_stats[ri][rj].count;
     706         2400 :                 rec_len = stats->record_stats[ri][rj].rec_len;
     707         2400 :                 fpi_len = stats->record_stats[ri][rj].fpi_len;
     708         2400 :                 tot_len = rec_len + fpi_len;
     709              : 
     710              :                 /* Skip undefined combinations and ones that didn't occur */
     711         2400 :                 if (count == 0)
     712         2343 :                     continue;
     713              : 
     714              :                 /* the upper four bits in xl_info are the rmgr's */
     715           57 :                 id = desc->rm_identify(rj << 4);
     716           57 :                 if (id == NULL)
     717            0 :                     id = psprintf("UNKNOWN (%x)", rj << 4);
     718              : 
     719           57 :                 XLogDumpStatsRow(psprintf("%s/%s", desc->rm_name, id),
     720              :                                  count, total_count, rec_len, total_rec_len,
     721              :                                  fpi_len, total_fpi_len, tot_len, total_len);
     722              :             }
     723              :         }
     724              :     }
     725              : 
     726            2 :     printf("%-27s %20s %8s %20s %8s %20s %8s %20s\n",
     727              :            "", "--------", "", "--------", "", "--------", "", "--------");
     728              : 
     729              :     /*
     730              :      * The percentages in earlier rows were calculated against the column
     731              :      * total, but the ones that follow are against the row total. Note that
     732              :      * these are displayed with a % symbol to differentiate them from the
     733              :      * earlier ones, and are thus up to 9 characters long.
     734              :      */
     735              : 
     736            2 :     rec_len_pct = 0;
     737            2 :     if (total_len != 0)
     738            2 :         rec_len_pct = 100 * (double) total_rec_len / total_len;
     739              : 
     740            2 :     fpi_len_pct = 0;
     741            2 :     if (total_len != 0)
     742            2 :         fpi_len_pct = 100 * (double) total_fpi_len / total_len;
     743              : 
     744            2 :     printf("%-27s "
     745              :            "%20" PRIu64 " %-9s"
     746              :            "%20" PRIu64 " %-9s"
     747              :            "%20" PRIu64 " %-9s"
     748              :            "%20" PRIu64 " %-6s\n",
     749              :            "Total", stats->count, "",
     750              :            total_rec_len, psprintf("[%.02f%%]", rec_len_pct),
     751              :            total_fpi_len, psprintf("[%.02f%%]", fpi_len_pct),
     752              :            total_len, "[100%]");
     753              : }
     754              : 
     755              : static void
     756            1 : usage(void)
     757              : {
     758            1 :     printf(_("%s decodes and displays PostgreSQL write-ahead logs for debugging.\n\n"),
     759              :            progname);
     760            1 :     printf(_("Usage:\n"));
     761            1 :     printf(_("  %s [OPTION]... [STARTSEG [ENDSEG]]\n"), progname);
     762            1 :     printf(_("\nOptions:\n"));
     763            1 :     printf(_("  -b, --bkp-details      output detailed information about backup blocks\n"));
     764            1 :     printf(_("  -B, --block=N          with --relation, only show records that modify block N\n"));
     765            1 :     printf(_("  -e, --end=RECPTR       stop reading at WAL location RECPTR\n"));
     766            1 :     printf(_("  -f, --follow           keep retrying after reaching end of WAL\n"));
     767            1 :     printf(_("  -F, --fork=FORK        only show records that modify blocks in fork FORK;\n"
     768              :              "                         valid names are main, fsm, vm, init\n"));
     769            1 :     printf(_("  -n, --limit=N          number of records to display\n"));
     770            1 :     printf(_("  -p, --path=PATH        directory in which to find WAL segment files or a\n"
     771              :              "                         directory with a ./pg_wal that contains such files\n"
     772              :              "                         (default: current directory, ./pg_wal, $PGDATA/pg_wal)\n"));
     773            1 :     printf(_("  -q, --quiet            do not print any output, except for errors\n"));
     774            1 :     printf(_("  -r, --rmgr=RMGR        only show records generated by resource manager RMGR;\n"
     775              :              "                         use --rmgr=list to list valid resource manager names\n"));
     776            1 :     printf(_("  -R, --relation=T/D/R   only show records that modify blocks in relation T/D/R\n"));
     777            1 :     printf(_("  -s, --start=RECPTR     start reading at WAL location RECPTR\n"));
     778            1 :     printf(_("  -t, --timeline=TLI     timeline from which to read WAL records\n"
     779              :              "                         (default: 1 or the value used in STARTSEG)\n"));
     780            1 :     printf(_("  -V, --version          output version information, then exit\n"));
     781            1 :     printf(_("  -w, --fullpage         only show records with a full page write\n"));
     782            1 :     printf(_("  -x, --xid=XID          only show records with transaction ID XID\n"));
     783            1 :     printf(_("  -z, --stats[=record]   show statistics instead of records\n"
     784              :              "                         (optionally, show per-record statistics)\n"));
     785            1 :     printf(_("  --save-fullpage=DIR    save full page images to DIR\n"));
     786            1 :     printf(_("  -?, --help             show this help, then exit\n"));
     787            1 :     printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
     788            1 :     printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
     789            1 : }
     790              : 
     791              : int
     792          170 : main(int argc, char **argv)
     793              : {
     794              :     uint32      xlogid;
     795              :     uint32      xrecoff;
     796              :     XLogReaderState *xlogreader_state;
     797              :     XLogDumpPrivate private;
     798              :     XLogDumpConfig config;
     799              :     XLogStats   stats;
     800              :     XLogRecord *record;
     801              :     XLogRecPtr  first_record;
     802          170 :     char       *waldir = NULL;
     803              :     char       *errormsg;
     804              :     int         WalSegSz;
     805              : 
     806              :     static struct option long_options[] = {
     807              :         {"bkp-details", no_argument, NULL, 'b'},
     808              :         {"block", required_argument, NULL, 'B'},
     809              :         {"end", required_argument, NULL, 'e'},
     810              :         {"follow", no_argument, NULL, 'f'},
     811              :         {"fork", required_argument, NULL, 'F'},
     812              :         {"fullpage", no_argument, NULL, 'w'},
     813              :         {"help", no_argument, NULL, '?'},
     814              :         {"limit", required_argument, NULL, 'n'},
     815              :         {"path", required_argument, NULL, 'p'},
     816              :         {"quiet", no_argument, NULL, 'q'},
     817              :         {"relation", required_argument, NULL, 'R'},
     818              :         {"rmgr", required_argument, NULL, 'r'},
     819              :         {"start", required_argument, NULL, 's'},
     820              :         {"timeline", required_argument, NULL, 't'},
     821              :         {"xid", required_argument, NULL, 'x'},
     822              :         {"version", no_argument, NULL, 'V'},
     823              :         {"stats", optional_argument, NULL, 'z'},
     824              :         {"save-fullpage", required_argument, NULL, 1},
     825              :         {NULL, 0, NULL, 0}
     826              :     };
     827              : 
     828              :     int         option;
     829          170 :     int         optindex = 0;
     830              : 
     831              : #ifndef WIN32
     832          170 :     pqsignal(SIGINT, sigint_handler);
     833              : #endif
     834              : 
     835          170 :     pg_logging_init(argv[0]);
     836          170 :     set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_waldump"));
     837          170 :     progname = get_progname(argv[0]);
     838              : 
     839          170 :     if (argc > 1)
     840              :     {
     841          169 :         if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
     842              :         {
     843            1 :             usage();
     844            1 :             exit(0);
     845              :         }
     846          168 :         if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
     847              :         {
     848           88 :             puts("pg_waldump (PostgreSQL) " PG_VERSION);
     849           88 :             exit(0);
     850              :         }
     851              :     }
     852              : 
     853           81 :     memset(&private, 0, sizeof(XLogDumpPrivate));
     854           81 :     memset(&config, 0, sizeof(XLogDumpConfig));
     855           81 :     memset(&stats, 0, sizeof(XLogStats));
     856              : 
     857           81 :     private.timeline = 1;
     858           81 :     private.startptr = InvalidXLogRecPtr;
     859           81 :     private.endptr = InvalidXLogRecPtr;
     860           81 :     private.endptr_reached = false;
     861              : 
     862           81 :     config.quiet = false;
     863           81 :     config.bkp_details = false;
     864           81 :     config.stop_after_records = -1;
     865           81 :     config.already_displayed_records = 0;
     866           81 :     config.follow = false;
     867              :     /* filter_by_rmgr array was zeroed by memset above */
     868           81 :     config.filter_by_rmgr_enabled = false;
     869           81 :     config.filter_by_xid = InvalidTransactionId;
     870           81 :     config.filter_by_xid_enabled = false;
     871           81 :     config.filter_by_extended = false;
     872           81 :     config.filter_by_relation_enabled = false;
     873           81 :     config.filter_by_relation_block_enabled = false;
     874           81 :     config.filter_by_relation_forknum = InvalidForkNumber;
     875           81 :     config.filter_by_fpw = false;
     876           81 :     config.save_fullpage_path = NULL;
     877           81 :     config.stats = false;
     878           81 :     config.stats_per_record = false;
     879              : 
     880           81 :     stats.startptr = InvalidXLogRecPtr;
     881           81 :     stats.endptr = InvalidXLogRecPtr;
     882              : 
     883           81 :     if (argc <= 1)
     884              :     {
     885            1 :         pg_log_error("no arguments specified");
     886            1 :         goto bad_argument;
     887              :     }
     888              : 
     889          380 :     while ((option = getopt_long(argc, argv, "bB:e:fF:n:p:qr:R:s:t:wx:z",
     890          380 :                                  long_options, &optindex)) != -1)
     891              :     {
     892          309 :         switch (option)
     893              :         {
     894            0 :             case 'b':
     895            0 :                 config.bkp_details = true;
     896            0 :                 break;
     897            2 :             case 'B':
     898            2 :                 if (sscanf(optarg, "%u", &config.filter_by_relation_block) != 1 ||
     899            1 :                     !BlockNumberIsValid(config.filter_by_relation_block))
     900              :                 {
     901            1 :                     pg_log_error("invalid block number: \"%s\"", optarg);
     902            1 :                     goto bad_argument;
     903              :                 }
     904            1 :                 config.filter_by_relation_block_enabled = true;
     905            1 :                 config.filter_by_extended = true;
     906            1 :                 break;
     907           61 :             case 'e':
     908           61 :                 if (sscanf(optarg, "%X/%08X", &xlogid, &xrecoff) != 2)
     909              :                 {
     910            1 :                     pg_log_error("invalid WAL location: \"%s\"",
     911              :                                  optarg);
     912            1 :                     goto bad_argument;
     913              :                 }
     914           60 :                 private.endptr = (uint64) xlogid << 32 | xrecoff;
     915           60 :                 break;
     916            0 :             case 'f':
     917            0 :                 config.follow = true;
     918            0 :                 break;
     919            2 :             case 'F':
     920            2 :                 config.filter_by_relation_forknum = forkname_to_number(optarg);
     921            2 :                 if (config.filter_by_relation_forknum == InvalidForkNumber)
     922              :                 {
     923            1 :                     pg_log_error("invalid fork name: \"%s\"", optarg);
     924            1 :                     goto bad_argument;
     925              :                 }
     926            1 :                 config.filter_by_extended = true;
     927            1 :                 break;
     928            2 :             case 'n':
     929            2 :                 if (sscanf(optarg, "%d", &config.stop_after_records) != 1)
     930              :                 {
     931            1 :                     pg_log_error("invalid value \"%s\" for option %s", optarg, "-n/--limit");
     932            1 :                     goto bad_argument;
     933              :                 }
     934            1 :                 break;
     935           63 :             case 'p':
     936           63 :                 waldir = pg_strdup(optarg);
     937           63 :                 break;
     938           53 :             case 'q':
     939           53 :                 config.quiet = true;
     940           53 :                 break;
     941            3 :             case 'r':
     942              :                 {
     943              :                     int         rmid;
     944              : 
     945            3 :                     if (pg_strcasecmp(optarg, "list") == 0)
     946              :                     {
     947            1 :                         print_rmgr_list();
     948            1 :                         exit(EXIT_SUCCESS);
     949              :                     }
     950              : 
     951              :                     /*
     952              :                      * First look for the generated name of a custom rmgr, of
     953              :                      * the form "custom###". We accept this form, because the
     954              :                      * custom rmgr module is not loaded, so there's no way to
     955              :                      * know the real name. This convention should be
     956              :                      * consistent with that in rmgrdesc.c.
     957              :                      */
     958            2 :                     if (sscanf(optarg, "custom%03d", &rmid) == 1)
     959              :                     {
     960            0 :                         if (!RmgrIdIsCustom(rmid))
     961              :                         {
     962            0 :                             pg_log_error("custom resource manager \"%s\" does not exist",
     963              :                                          optarg);
     964            1 :                             goto bad_argument;
     965              :                         }
     966            0 :                         config.filter_by_rmgr[rmid] = true;
     967            0 :                         config.filter_by_rmgr_enabled = true;
     968              :                     }
     969              :                     else
     970              :                     {
     971              :                         /* then look for builtin rmgrs */
     972           35 :                         for (rmid = 0; rmid <= RM_MAX_BUILTIN_ID; rmid++)
     973              :                         {
     974           34 :                             if (pg_strcasecmp(optarg, GetRmgrDesc(rmid)->rm_name) == 0)
     975              :                             {
     976            1 :                                 config.filter_by_rmgr[rmid] = true;
     977            1 :                                 config.filter_by_rmgr_enabled = true;
     978            1 :                                 break;
     979              :                             }
     980              :                         }
     981            2 :                         if (rmid > RM_MAX_BUILTIN_ID)
     982              :                         {
     983            1 :                             pg_log_error("resource manager \"%s\" does not exist",
     984              :                                          optarg);
     985            1 :                             goto bad_argument;
     986              :                         }
     987              :                     }
     988              :                 }
     989            1 :                 break;
     990            4 :             case 'R':
     991            4 :                 if (sscanf(optarg, "%u/%u/%u",
     992              :                            &config.filter_by_relation.spcOid,
     993              :                            &config.filter_by_relation.dbOid,
     994            3 :                            &config.filter_by_relation.relNumber) != 3 ||
     995            3 :                     !OidIsValid(config.filter_by_relation.spcOid) ||
     996            3 :                     !RelFileNumberIsValid(config.filter_by_relation.relNumber))
     997              :                 {
     998            1 :                     pg_log_error("invalid relation specification: \"%s\"", optarg);
     999            1 :                     pg_log_error_detail("Expecting \"tablespace OID/database OID/relation filenode\".");
    1000            1 :                     goto bad_argument;
    1001              :                 }
    1002            3 :                 config.filter_by_relation_enabled = true;
    1003            3 :                 config.filter_by_extended = true;
    1004            3 :                 break;
    1005           64 :             case 's':
    1006           64 :                 if (sscanf(optarg, "%X/%08X", &xlogid, &xrecoff) != 2)
    1007              :                 {
    1008            1 :                     pg_log_error("invalid WAL location: \"%s\"",
    1009              :                                  optarg);
    1010            1 :                     goto bad_argument;
    1011              :                 }
    1012              :                 else
    1013           63 :                     private.startptr = (uint64) xlogid << 32 | xrecoff;
    1014           63 :                 break;
    1015           50 :             case 't':
    1016              : 
    1017              :                 /*
    1018              :                  * This is like option_parse_int() but needs to handle
    1019              :                  * unsigned 32-bit int.  Also, we accept both decimal and
    1020              :                  * hexadecimal specifications here.
    1021              :                  */
    1022              :                 {
    1023              :                     char       *endptr;
    1024              :                     unsigned long val;
    1025              : 
    1026           50 :                     errno = 0;
    1027           50 :                     val = strtoul(optarg, &endptr, 0);
    1028              : 
    1029           50 :                     while (*endptr != '\0' && isspace((unsigned char) *endptr))
    1030            0 :                         endptr++;
    1031              : 
    1032           50 :                     if (*endptr != '\0')
    1033              :                     {
    1034            0 :                         pg_log_error("invalid value \"%s\" for option %s",
    1035              :                                      optarg, "-t/--timeline");
    1036            0 :                         goto bad_argument;
    1037              :                     }
    1038              : 
    1039           50 :                     if (errno == ERANGE || val < 1 || val > UINT_MAX)
    1040              :                     {
    1041            0 :                         pg_log_error("%s must be in range %u..%u",
    1042              :                                      "-t/--timeline", 1, UINT_MAX);
    1043            0 :                         goto bad_argument;
    1044              :                     }
    1045              : 
    1046           50 :                     private.timeline = val;
    1047              : 
    1048           50 :                     break;
    1049              :                 }
    1050            1 :             case 'w':
    1051            1 :                 config.filter_by_fpw = true;
    1052            1 :                 break;
    1053            0 :             case 'x':
    1054            0 :                 if (sscanf(optarg, "%u", &config.filter_by_xid) != 1)
    1055              :                 {
    1056            0 :                     pg_log_error("invalid transaction ID specification: \"%s\"",
    1057              :                                  optarg);
    1058            0 :                     goto bad_argument;
    1059              :                 }
    1060            0 :                 config.filter_by_xid_enabled = true;
    1061            0 :                 break;
    1062            2 :             case 'z':
    1063            2 :                 config.stats = true;
    1064            2 :                 config.stats_per_record = false;
    1065            2 :                 if (optarg)
    1066              :                 {
    1067            1 :                     if (strcmp(optarg, "record") == 0)
    1068            1 :                         config.stats_per_record = true;
    1069            0 :                     else if (strcmp(optarg, "rmgr") != 0)
    1070              :                     {
    1071            0 :                         pg_log_error("unrecognized value for option %s: %s",
    1072              :                                      "--stats", optarg);
    1073            0 :                         goto bad_argument;
    1074              :                     }
    1075              :                 }
    1076            2 :                 break;
    1077            1 :             case 1:
    1078            1 :                 config.save_fullpage_path = pg_strdup(optarg);
    1079            1 :                 break;
    1080            1 :             default:
    1081            1 :                 goto bad_argument;
    1082              :         }
    1083              :     }
    1084              : 
    1085           71 :     if (config.filter_by_relation_block_enabled &&
    1086            1 :         !config.filter_by_relation_enabled)
    1087              :     {
    1088            0 :         pg_log_error("option %s requires option %s to be specified",
    1089              :                      "-B/--block", "-R/--relation");
    1090            0 :         goto bad_argument;
    1091              :     }
    1092              : 
    1093           71 :     if ((optind + 2) < argc)
    1094              :     {
    1095            1 :         pg_log_error("too many command-line arguments (first is \"%s\")",
    1096              :                      argv[optind + 2]);
    1097            1 :         goto bad_argument;
    1098              :     }
    1099              : 
    1100           70 :     if (waldir != NULL)
    1101              :     {
    1102              :         /* validate path points to directory */
    1103           63 :         if (!verify_directory(waldir))
    1104              :         {
    1105            1 :             pg_log_error("could not open directory \"%s\": %m", waldir);
    1106            1 :             goto bad_argument;
    1107              :         }
    1108              :     }
    1109              : 
    1110           69 :     if (config.save_fullpage_path != NULL)
    1111            1 :         create_fullpage_directory(config.save_fullpage_path);
    1112              : 
    1113              :     /* parse files as start/end boundaries, extract path if not specified */
    1114           69 :     if (optind < argc)
    1115              :     {
    1116            7 :         char       *directory = NULL;
    1117            7 :         char       *fname = NULL;
    1118              :         int         fd;
    1119              :         XLogSegNo   segno;
    1120              : 
    1121            7 :         split_path(argv[optind], &directory, &fname);
    1122              : 
    1123            7 :         if (waldir == NULL && directory != NULL)
    1124              :         {
    1125            6 :             waldir = directory;
    1126              : 
    1127            6 :             if (!verify_directory(waldir))
    1128            0 :                 pg_fatal("could not open directory \"%s\": %m", waldir);
    1129              :         }
    1130              : 
    1131            7 :         waldir = identify_target_directory(waldir, fname, &WalSegSz);
    1132            6 :         fd = open_file_in_directory(waldir, fname);
    1133            6 :         if (fd < 0)
    1134            0 :             pg_fatal("could not open file \"%s\"", fname);
    1135            6 :         close(fd);
    1136              : 
    1137              :         /* parse position from file */
    1138            6 :         XLogFromFileName(fname, &private.timeline, &segno, WalSegSz);
    1139              : 
    1140            6 :         if (!XLogRecPtrIsValid(private.startptr))
    1141            5 :             XLogSegNoOffsetToRecPtr(segno, 0, WalSegSz, private.startptr);
    1142            1 :         else if (!XLByteInSeg(private.startptr, segno, WalSegSz))
    1143              :         {
    1144            0 :             pg_log_error("start WAL location %X/%08X is not inside file \"%s\"",
    1145              :                          LSN_FORMAT_ARGS(private.startptr),
    1146              :                          fname);
    1147            0 :             goto bad_argument;
    1148              :         }
    1149              : 
    1150              :         /* no second file specified, set end position */
    1151            6 :         if (!(optind + 1 < argc) && !XLogRecPtrIsValid(private.endptr))
    1152            4 :             XLogSegNoOffsetToRecPtr(segno + 1, 0, WalSegSz, private.endptr);
    1153              : 
    1154              :         /* parse ENDSEG if passed */
    1155            6 :         if (optind + 1 < argc)
    1156              :         {
    1157              :             XLogSegNo   endsegno;
    1158              : 
    1159              :             /* ignore directory, already have that */
    1160            2 :             split_path(argv[optind + 1], &directory, &fname);
    1161              : 
    1162            2 :             fd = open_file_in_directory(waldir, fname);
    1163            2 :             if (fd < 0)
    1164            1 :                 pg_fatal("could not open file \"%s\"", fname);
    1165            1 :             close(fd);
    1166              : 
    1167              :             /* parse position from file */
    1168            1 :             XLogFromFileName(fname, &private.timeline, &endsegno, WalSegSz);
    1169              : 
    1170            1 :             if (endsegno < segno)
    1171            0 :                 pg_fatal("ENDSEG %s is before STARTSEG %s",
    1172              :                          argv[optind + 1], argv[optind]);
    1173              : 
    1174            1 :             if (!XLogRecPtrIsValid(private.endptr))
    1175            1 :                 XLogSegNoOffsetToRecPtr(endsegno + 1, 0, WalSegSz,
    1176              :                                         private.endptr);
    1177              : 
    1178              :             /* set segno to endsegno for check of --end */
    1179            1 :             segno = endsegno;
    1180              :         }
    1181              : 
    1182              : 
    1183            5 :         if (!XLByteInSeg(private.endptr, segno, WalSegSz) &&
    1184            5 :             private.endptr != (segno + 1) * WalSegSz)
    1185              :         {
    1186            0 :             pg_log_error("end WAL location %X/%08X is not inside file \"%s\"",
    1187              :                          LSN_FORMAT_ARGS(private.endptr),
    1188              :                          argv[argc - 1]);
    1189            0 :             goto bad_argument;
    1190              :         }
    1191              :     }
    1192              :     else
    1193           62 :         waldir = identify_target_directory(waldir, NULL, &WalSegSz);
    1194              : 
    1195              :     /* we don't know what to print */
    1196           66 :     if (!XLogRecPtrIsValid(private.startptr))
    1197              :     {
    1198            1 :         pg_log_error("no start WAL location given");
    1199            1 :         goto bad_argument;
    1200              :     }
    1201              : 
    1202              :     /* done with argument parsing, do the actual work */
    1203              : 
    1204              :     /* we have everything we need, start reading */
    1205              :     xlogreader_state =
    1206           65 :         XLogReaderAllocate(WalSegSz, waldir,
    1207           65 :                            XL_ROUTINE(.page_read = WALDumpReadPage,
    1208              :                                       .segment_open = WALDumpOpenSegment,
    1209              :                                       .segment_close = WALDumpCloseSegment),
    1210              :                            &private);
    1211           65 :     if (!xlogreader_state)
    1212            0 :         pg_fatal("out of memory while allocating a WAL reading processor");
    1213              : 
    1214              :     /* first find a valid recptr to start from */
    1215           65 :     first_record = XLogFindNextRecord(xlogreader_state, private.startptr);
    1216              : 
    1217           65 :     if (!XLogRecPtrIsValid(first_record))
    1218            0 :         pg_fatal("could not find a valid record after %X/%08X",
    1219              :                  LSN_FORMAT_ARGS(private.startptr));
    1220              : 
    1221              :     /*
    1222              :      * Display a message that we're skipping data if `from` wasn't a pointer
    1223              :      * to the start of a record and also wasn't a pointer to the beginning of
    1224              :      * a segment (e.g. we were used in file mode).
    1225              :      */
    1226           65 :     if (first_record != private.startptr &&
    1227            5 :         XLogSegmentOffset(private.startptr, WalSegSz) != 0)
    1228            1 :         pg_log_info(ngettext("first record is after %X/%08X, at %X/%08X, skipping over %u byte",
    1229              :                              "first record is after %X/%08X, at %X/%08X, skipping over %u bytes",
    1230              :                              (first_record - private.startptr)),
    1231              :                     LSN_FORMAT_ARGS(private.startptr),
    1232              :                     LSN_FORMAT_ARGS(first_record),
    1233              :                     (uint32) (first_record - private.startptr));
    1234              : 
    1235           65 :     if (config.stats == true && !config.quiet)
    1236            2 :         stats.startptr = first_record;
    1237              : 
    1238              :     for (;;)
    1239              :     {
    1240       615151 :         if (time_to_stop)
    1241              :         {
    1242              :             /* We've been Ctrl-C'ed, so leave */
    1243            0 :             break;
    1244              :         }
    1245              : 
    1246              :         /* try to read the next record */
    1247       615151 :         record = XLogReadRecord(xlogreader_state, &errormsg);
    1248       615151 :         if (!record)
    1249              :         {
    1250           64 :             if (!config.follow || private.endptr_reached)
    1251              :                 break;
    1252              :             else
    1253              :             {
    1254            0 :                 pg_usleep(1000000L);    /* 1 second */
    1255            0 :                 continue;
    1256              :             }
    1257              :         }
    1258              : 
    1259              :         /* apply all specified filters */
    1260       615087 :         if (config.filter_by_rmgr_enabled &&
    1261        34464 :             !config.filter_by_rmgr[record->xl_rmid])
    1262        33471 :             continue;
    1263              : 
    1264       581616 :         if (config.filter_by_xid_enabled &&
    1265            0 :             config.filter_by_xid != record->xl_xid)
    1266            0 :             continue;
    1267              : 
    1268              :         /* check for extended filtering */
    1269       581616 :         if (config.filter_by_extended &&
    1270       256114 :             !XLogRecordMatchesRelationBlock(xlogreader_state,
    1271       128057 :                                             config.filter_by_relation_enabled ?
    1272              :                                             config.filter_by_relation :
    1273              :                                             emptyRelFileLocator,
    1274       128057 :                                             config.filter_by_relation_block_enabled ?
    1275              :                                             config.filter_by_relation_block :
    1276              :                                             InvalidBlockNumber,
    1277              :                                             config.filter_by_relation_forknum))
    1278       127849 :             continue;
    1279              : 
    1280       453767 :         if (config.filter_by_fpw && !XLogRecordHasFPW(xlogreader_state))
    1281        33393 :             continue;
    1282              : 
    1283              :         /* perform any per-record work */
    1284       420374 :         if (!config.quiet)
    1285              :         {
    1286       326631 :             if (config.stats == true)
    1287              :             {
    1288        68928 :                 XLogRecStoreStats(&stats, xlogreader_state);
    1289        68928 :                 stats.endptr = xlogreader_state->EndRecPtr;
    1290              :             }
    1291              :             else
    1292       257703 :                 XLogDumpDisplayRecord(&config, xlogreader_state);
    1293              :         }
    1294              : 
    1295              :         /* save full pages if requested */
    1296       420374 :         if (config.save_fullpage_path != NULL)
    1297          201 :             XLogRecordSaveFPWs(xlogreader_state, config.save_fullpage_path);
    1298              : 
    1299              :         /* check whether we printed enough */
    1300       420374 :         config.already_displayed_records++;
    1301       420374 :         if (config.stop_after_records > 0 &&
    1302            6 :             config.already_displayed_records >= config.stop_after_records)
    1303            1 :             break;
    1304              :     }
    1305              : 
    1306           65 :     if (config.stats == true && !config.quiet)
    1307            2 :         XLogDumpDisplayStats(&config, &stats);
    1308              : 
    1309           65 :     if (time_to_stop)
    1310            0 :         exit(0);
    1311              : 
    1312           65 :     if (errormsg)
    1313            2 :         pg_fatal("error in WAL record at %X/%08X: %s",
    1314              :                  LSN_FORMAT_ARGS(xlogreader_state->ReadRecPtr),
    1315              :                  errormsg);
    1316              : 
    1317           63 :     XLogReaderFree(xlogreader_state);
    1318              : 
    1319           63 :     return EXIT_SUCCESS;
    1320              : 
    1321           12 : bad_argument:
    1322           12 :     pg_log_error_hint("Try \"%s --help\" for more information.", progname);
    1323           12 :     return EXIT_FAILURE;
    1324              : }
        

Generated by: LCOV version 2.0-1