LCOV - code coverage report
Current view: top level - src/bin/pg_waldump - xactdesc.c (source / functions) Hit Total Coverage
Test: PostgreSQL 14devel Lines: 0 208 0.0 %
Date: 2020-11-27 12:05:55 Functions: 0 11 0.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /*-------------------------------------------------------------------------
       2             :  *
       3             :  * xactdesc.c
       4             :  *    rmgr descriptor routines for access/transam/xact.c
       5             :  *
       6             :  * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
       7             :  * Portions Copyright (c) 1994, Regents of the University of California
       8             :  *
       9             :  *
      10             :  * IDENTIFICATION
      11             :  *    src/backend/access/rmgrdesc/xactdesc.c
      12             :  *
      13             :  *-------------------------------------------------------------------------
      14             :  */
      15             : #include "postgres.h"
      16             : 
      17             : #include "access/transam.h"
      18             : #include "access/xact.h"
      19             : #include "storage/sinval.h"
      20             : #include "storage/standbydefs.h"
      21             : #include "utils/timestamp.h"
      22             : 
      23             : /*
      24             :  * Parse the WAL format of an xact commit and abort records into an easier to
      25             :  * understand format.
      26             :  *
      27             :  * This routines are in xactdesc.c because they're accessed in backend (when
      28             :  * replaying WAL) and frontend (pg_waldump) code. This file is the only xact
      29             :  * specific one shared between both. They're complicated enough that
      30             :  * duplication would be bothersome.
      31             :  */
      32             : 
      33             : void
      34           0 : ParseCommitRecord(uint8 info, xl_xact_commit *xlrec, xl_xact_parsed_commit *parsed)
      35             : {
      36           0 :     char       *data = ((char *) xlrec) + MinSizeOfXactCommit;
      37             : 
      38           0 :     memset(parsed, 0, sizeof(*parsed));
      39             : 
      40           0 :     parsed->xinfo = 0;           /* default, if no XLOG_XACT_HAS_INFO is
      41             :                                  * present */
      42             : 
      43           0 :     parsed->xact_time = xlrec->xact_time;
      44             : 
      45           0 :     if (info & XLOG_XACT_HAS_INFO)
      46             :     {
      47           0 :         xl_xact_xinfo *xl_xinfo = (xl_xact_xinfo *) data;
      48             : 
      49           0 :         parsed->xinfo = xl_xinfo->xinfo;
      50             : 
      51           0 :         data += sizeof(xl_xact_xinfo);
      52             :     }
      53             : 
      54           0 :     if (parsed->xinfo & XACT_XINFO_HAS_DBINFO)
      55             :     {
      56           0 :         xl_xact_dbinfo *xl_dbinfo = (xl_xact_dbinfo *) data;
      57             : 
      58           0 :         parsed->dbId = xl_dbinfo->dbId;
      59           0 :         parsed->tsId = xl_dbinfo->tsId;
      60             : 
      61           0 :         data += sizeof(xl_xact_dbinfo);
      62             :     }
      63             : 
      64           0 :     if (parsed->xinfo & XACT_XINFO_HAS_SUBXACTS)
      65             :     {
      66           0 :         xl_xact_subxacts *xl_subxacts = (xl_xact_subxacts *) data;
      67             : 
      68           0 :         parsed->nsubxacts = xl_subxacts->nsubxacts;
      69           0 :         parsed->subxacts = xl_subxacts->subxacts;
      70             : 
      71           0 :         data += MinSizeOfXactSubxacts;
      72           0 :         data += parsed->nsubxacts * sizeof(TransactionId);
      73             :     }
      74             : 
      75           0 :     if (parsed->xinfo & XACT_XINFO_HAS_RELFILENODES)
      76             :     {
      77           0 :         xl_xact_relfilenodes *xl_relfilenodes = (xl_xact_relfilenodes *) data;
      78             : 
      79           0 :         parsed->nrels = xl_relfilenodes->nrels;
      80           0 :         parsed->xnodes = xl_relfilenodes->xnodes;
      81             : 
      82           0 :         data += MinSizeOfXactRelfilenodes;
      83           0 :         data += xl_relfilenodes->nrels * sizeof(RelFileNode);
      84             :     }
      85             : 
      86           0 :     if (parsed->xinfo & XACT_XINFO_HAS_INVALS)
      87             :     {
      88           0 :         xl_xact_invals *xl_invals = (xl_xact_invals *) data;
      89             : 
      90           0 :         parsed->nmsgs = xl_invals->nmsgs;
      91           0 :         parsed->msgs = xl_invals->msgs;
      92             : 
      93           0 :         data += MinSizeOfXactInvals;
      94           0 :         data += xl_invals->nmsgs * sizeof(SharedInvalidationMessage);
      95             :     }
      96             : 
      97           0 :     if (parsed->xinfo & XACT_XINFO_HAS_TWOPHASE)
      98             :     {
      99           0 :         xl_xact_twophase *xl_twophase = (xl_xact_twophase *) data;
     100             : 
     101           0 :         parsed->twophase_xid = xl_twophase->xid;
     102             : 
     103           0 :         data += sizeof(xl_xact_twophase);
     104             : 
     105           0 :         if (parsed->xinfo & XACT_XINFO_HAS_GID)
     106             :         {
     107           0 :             strlcpy(parsed->twophase_gid, data, sizeof(parsed->twophase_gid));
     108           0 :             data += strlen(data) + 1;
     109             :         }
     110             :     }
     111             : 
     112             :     /* Note: no alignment is guaranteed after this point */
     113             : 
     114           0 :     if (parsed->xinfo & XACT_XINFO_HAS_ORIGIN)
     115             :     {
     116             :         xl_xact_origin xl_origin;
     117             : 
     118             :         /* no alignment is guaranteed, so copy onto stack */
     119           0 :         memcpy(&xl_origin, data, sizeof(xl_origin));
     120             : 
     121           0 :         parsed->origin_lsn = xl_origin.origin_lsn;
     122           0 :         parsed->origin_timestamp = xl_origin.origin_timestamp;
     123             : 
     124           0 :         data += sizeof(xl_xact_origin);
     125             :     }
     126           0 : }
     127             : 
     128             : void
     129           0 : ParseAbortRecord(uint8 info, xl_xact_abort *xlrec, xl_xact_parsed_abort *parsed)
     130             : {
     131           0 :     char       *data = ((char *) xlrec) + MinSizeOfXactAbort;
     132             : 
     133           0 :     memset(parsed, 0, sizeof(*parsed));
     134             : 
     135           0 :     parsed->xinfo = 0;           /* default, if no XLOG_XACT_HAS_INFO is
     136             :                                  * present */
     137             : 
     138           0 :     parsed->xact_time = xlrec->xact_time;
     139             : 
     140           0 :     if (info & XLOG_XACT_HAS_INFO)
     141             :     {
     142           0 :         xl_xact_xinfo *xl_xinfo = (xl_xact_xinfo *) data;
     143             : 
     144           0 :         parsed->xinfo = xl_xinfo->xinfo;
     145             : 
     146           0 :         data += sizeof(xl_xact_xinfo);
     147             :     }
     148             : 
     149           0 :     if (parsed->xinfo & XACT_XINFO_HAS_DBINFO)
     150             :     {
     151           0 :         xl_xact_dbinfo *xl_dbinfo = (xl_xact_dbinfo *) data;
     152             : 
     153           0 :         parsed->dbId = xl_dbinfo->dbId;
     154           0 :         parsed->tsId = xl_dbinfo->tsId;
     155             : 
     156           0 :         data += sizeof(xl_xact_dbinfo);
     157             :     }
     158             : 
     159           0 :     if (parsed->xinfo & XACT_XINFO_HAS_SUBXACTS)
     160             :     {
     161           0 :         xl_xact_subxacts *xl_subxacts = (xl_xact_subxacts *) data;
     162             : 
     163           0 :         parsed->nsubxacts = xl_subxacts->nsubxacts;
     164           0 :         parsed->subxacts = xl_subxacts->subxacts;
     165             : 
     166           0 :         data += MinSizeOfXactSubxacts;
     167           0 :         data += parsed->nsubxacts * sizeof(TransactionId);
     168             :     }
     169             : 
     170           0 :     if (parsed->xinfo & XACT_XINFO_HAS_RELFILENODES)
     171             :     {
     172           0 :         xl_xact_relfilenodes *xl_relfilenodes = (xl_xact_relfilenodes *) data;
     173             : 
     174           0 :         parsed->nrels = xl_relfilenodes->nrels;
     175           0 :         parsed->xnodes = xl_relfilenodes->xnodes;
     176             : 
     177           0 :         data += MinSizeOfXactRelfilenodes;
     178           0 :         data += xl_relfilenodes->nrels * sizeof(RelFileNode);
     179             :     }
     180             : 
     181           0 :     if (parsed->xinfo & XACT_XINFO_HAS_TWOPHASE)
     182             :     {
     183           0 :         xl_xact_twophase *xl_twophase = (xl_xact_twophase *) data;
     184             : 
     185           0 :         parsed->twophase_xid = xl_twophase->xid;
     186             : 
     187           0 :         data += sizeof(xl_xact_twophase);
     188             : 
     189           0 :         if (parsed->xinfo & XACT_XINFO_HAS_GID)
     190             :         {
     191           0 :             strlcpy(parsed->twophase_gid, data, sizeof(parsed->twophase_gid));
     192           0 :             data += strlen(data) + 1;
     193             :         }
     194             :     }
     195             : 
     196             :     /* Note: no alignment is guaranteed after this point */
     197             : 
     198           0 :     if (parsed->xinfo & XACT_XINFO_HAS_ORIGIN)
     199             :     {
     200             :         xl_xact_origin xl_origin;
     201             : 
     202             :         /* no alignment is guaranteed, so copy onto stack */
     203           0 :         memcpy(&xl_origin, data, sizeof(xl_origin));
     204             : 
     205           0 :         parsed->origin_lsn = xl_origin.origin_lsn;
     206           0 :         parsed->origin_timestamp = xl_origin.origin_timestamp;
     207             : 
     208           0 :         data += sizeof(xl_xact_origin);
     209             :     }
     210           0 : }
     211             : 
     212             : /*
     213             :  * ParsePrepareRecord
     214             :  */
     215             : void
     216           0 : ParsePrepareRecord(uint8 info, xl_xact_prepare *xlrec, xl_xact_parsed_prepare *parsed)
     217             : {
     218             :     char       *bufptr;
     219             : 
     220           0 :     bufptr = ((char *) xlrec) + MAXALIGN(sizeof(xl_xact_prepare));
     221             : 
     222           0 :     memset(parsed, 0, sizeof(*parsed));
     223             : 
     224           0 :     parsed->xact_time = xlrec->prepared_at;
     225           0 :     parsed->origin_lsn = xlrec->origin_lsn;
     226           0 :     parsed->origin_timestamp = xlrec->origin_timestamp;
     227           0 :     parsed->twophase_xid = xlrec->xid;
     228           0 :     parsed->dbId = xlrec->database;
     229           0 :     parsed->nsubxacts = xlrec->nsubxacts;
     230           0 :     parsed->nrels = xlrec->ncommitrels;
     231           0 :     parsed->nabortrels = xlrec->nabortrels;
     232           0 :     parsed->nmsgs = xlrec->ninvalmsgs;
     233             : 
     234           0 :     strncpy(parsed->twophase_gid, bufptr, xlrec->gidlen);
     235           0 :     bufptr += MAXALIGN(xlrec->gidlen);
     236             : 
     237           0 :     parsed->subxacts = (TransactionId *) bufptr;
     238           0 :     bufptr += MAXALIGN(xlrec->nsubxacts * sizeof(TransactionId));
     239             : 
     240           0 :     parsed->xnodes = (RelFileNode *) bufptr;
     241           0 :     bufptr += MAXALIGN(xlrec->ncommitrels * sizeof(RelFileNode));
     242             : 
     243           0 :     parsed->abortnodes = (RelFileNode *) bufptr;
     244           0 :     bufptr += MAXALIGN(xlrec->nabortrels * sizeof(RelFileNode));
     245             : 
     246           0 :     parsed->msgs = (SharedInvalidationMessage *) bufptr;
     247           0 :     bufptr += MAXALIGN(xlrec->ninvalmsgs * sizeof(SharedInvalidationMessage));
     248           0 : }
     249             : 
     250             : static void
     251           0 : xact_desc_relations(StringInfo buf, char *label, int nrels,
     252             :                     RelFileNode *xnodes)
     253             : {
     254             :     int         i;
     255             : 
     256           0 :     if (nrels > 0)
     257             :     {
     258           0 :         appendStringInfo(buf, "; %s:", label);
     259           0 :         for (i = 0; i < nrels; i++)
     260             :         {
     261           0 :             char       *path = relpathperm(xnodes[i], MAIN_FORKNUM);
     262             : 
     263           0 :             appendStringInfo(buf, " %s", path);
     264           0 :             pfree(path);
     265             :         }
     266             :     }
     267           0 : }
     268             : 
     269             : static void
     270           0 : xact_desc_subxacts(StringInfo buf, int nsubxacts, TransactionId *subxacts)
     271             : {
     272             :     int         i;
     273             : 
     274           0 :     if (nsubxacts > 0)
     275             :     {
     276           0 :         appendStringInfoString(buf, "; subxacts:");
     277           0 :         for (i = 0; i < nsubxacts; i++)
     278           0 :             appendStringInfo(buf, " %u", subxacts[i]);
     279             :     }
     280           0 : }
     281             : 
     282             : static void
     283           0 : xact_desc_commit(StringInfo buf, uint8 info, xl_xact_commit *xlrec, RepOriginId origin_id)
     284             : {
     285             :     xl_xact_parsed_commit parsed;
     286             : 
     287           0 :     ParseCommitRecord(info, xlrec, &parsed);
     288             : 
     289             :     /* If this is a prepared xact, show the xid of the original xact */
     290           0 :     if (TransactionIdIsValid(parsed.twophase_xid))
     291           0 :         appendStringInfo(buf, "%u: ", parsed.twophase_xid);
     292             : 
     293           0 :     appendStringInfoString(buf, timestamptz_to_str(xlrec->xact_time));
     294             : 
     295           0 :     xact_desc_relations(buf, "rels", parsed.nrels, parsed.xnodes);
     296           0 :     xact_desc_subxacts(buf, parsed.nsubxacts, parsed.subxacts);
     297             : 
     298           0 :     standby_desc_invalidations(buf, parsed.nmsgs, parsed.msgs, parsed.dbId,
     299             :                                parsed.tsId,
     300           0 :                                XactCompletionRelcacheInitFileInval(parsed.xinfo));
     301             : 
     302           0 :     if (XactCompletionForceSyncCommit(parsed.xinfo))
     303           0 :         appendStringInfoString(buf, "; sync");
     304             : 
     305           0 :     if (parsed.xinfo & XACT_XINFO_HAS_ORIGIN)
     306             :     {
     307           0 :         appendStringInfo(buf, "; origin: node %u, lsn %X/%X, at %s",
     308             :                          origin_id,
     309           0 :                          (uint32) (parsed.origin_lsn >> 32),
     310           0 :                          (uint32) parsed.origin_lsn,
     311             :                          timestamptz_to_str(parsed.origin_timestamp));
     312             :     }
     313           0 : }
     314             : 
     315             : static void
     316           0 : xact_desc_abort(StringInfo buf, uint8 info, xl_xact_abort *xlrec)
     317             : {
     318             :     xl_xact_parsed_abort parsed;
     319             : 
     320           0 :     ParseAbortRecord(info, xlrec, &parsed);
     321             : 
     322             :     /* If this is a prepared xact, show the xid of the original xact */
     323           0 :     if (TransactionIdIsValid(parsed.twophase_xid))
     324           0 :         appendStringInfo(buf, "%u: ", parsed.twophase_xid);
     325             : 
     326           0 :     appendStringInfoString(buf, timestamptz_to_str(xlrec->xact_time));
     327             : 
     328           0 :     xact_desc_relations(buf, "rels", parsed.nrels, parsed.xnodes);
     329           0 :     xact_desc_subxacts(buf, parsed.nsubxacts, parsed.subxacts);
     330           0 : }
     331             : 
     332             : static void
     333           0 : xact_desc_prepare(StringInfo buf, uint8 info, xl_xact_prepare *xlrec)
     334             : {
     335             :     xl_xact_parsed_prepare parsed;
     336             : 
     337           0 :     ParsePrepareRecord(info, xlrec, &parsed);
     338             : 
     339           0 :     appendStringInfo(buf, "gid %s: ", parsed.twophase_gid);
     340           0 :     appendStringInfoString(buf, timestamptz_to_str(parsed.xact_time));
     341             : 
     342           0 :     xact_desc_relations(buf, "rels(commit)", parsed.nrels, parsed.xnodes);
     343           0 :     xact_desc_relations(buf, "rels(abort)", parsed.nabortrels,
     344             :                         parsed.abortnodes);
     345           0 :     xact_desc_subxacts(buf, parsed.nsubxacts, parsed.subxacts);
     346             : 
     347           0 :     standby_desc_invalidations(buf, parsed.nmsgs, parsed.msgs, parsed.dbId,
     348           0 :                                parsed.tsId, xlrec->initfileinval);
     349           0 : }
     350             : 
     351             : static void
     352           0 : xact_desc_assignment(StringInfo buf, xl_xact_assignment *xlrec)
     353             : {
     354             :     int         i;
     355             : 
     356           0 :     appendStringInfoString(buf, "subxacts:");
     357             : 
     358           0 :     for (i = 0; i < xlrec->nsubxacts; i++)
     359           0 :         appendStringInfo(buf, " %u", xlrec->xsub[i]);
     360           0 : }
     361             : 
     362             : void
     363           0 : xact_desc(StringInfo buf, XLogReaderState *record)
     364             : {
     365           0 :     char       *rec = XLogRecGetData(record);
     366           0 :     uint8       info = XLogRecGetInfo(record) & XLOG_XACT_OPMASK;
     367             : 
     368           0 :     if (info == XLOG_XACT_COMMIT || info == XLOG_XACT_COMMIT_PREPARED)
     369           0 :     {
     370           0 :         xl_xact_commit *xlrec = (xl_xact_commit *) rec;
     371             : 
     372           0 :         xact_desc_commit(buf, XLogRecGetInfo(record), xlrec,
     373           0 :                          XLogRecGetOrigin(record));
     374             :     }
     375           0 :     else if (info == XLOG_XACT_ABORT || info == XLOG_XACT_ABORT_PREPARED)
     376           0 :     {
     377           0 :         xl_xact_abort *xlrec = (xl_xact_abort *) rec;
     378             : 
     379           0 :         xact_desc_abort(buf, XLogRecGetInfo(record), xlrec);
     380             :     }
     381           0 :     else if (info == XLOG_XACT_PREPARE)
     382             :     {
     383           0 :         xl_xact_prepare *xlrec = (xl_xact_prepare *) rec;
     384             : 
     385           0 :         xact_desc_prepare(buf, XLogRecGetInfo(record), xlrec);
     386             :     }
     387           0 :     else if (info == XLOG_XACT_ASSIGNMENT)
     388             :     {
     389           0 :         xl_xact_assignment *xlrec = (xl_xact_assignment *) rec;
     390             : 
     391             :         /*
     392             :          * Note that we ignore the WAL record's xid, since we're more
     393             :          * interested in the top-level xid that issued the record and which
     394             :          * xids are being reported here.
     395             :          */
     396           0 :         appendStringInfo(buf, "xtop %u: ", xlrec->xtop);
     397           0 :         xact_desc_assignment(buf, xlrec);
     398             :     }
     399           0 :     else if (info == XLOG_XACT_INVALIDATIONS)
     400             :     {
     401           0 :         xl_xact_invals *xlrec = (xl_xact_invals *) rec;
     402             : 
     403           0 :         standby_desc_invalidations(buf, xlrec->nmsgs, xlrec->msgs, InvalidOid,
     404             :                                    InvalidOid, false);
     405             :     }
     406           0 : }
     407             : 
     408             : const char *
     409           0 : xact_identify(uint8 info)
     410             : {
     411           0 :     const char *id = NULL;
     412             : 
     413           0 :     switch (info & XLOG_XACT_OPMASK)
     414             :     {
     415           0 :         case XLOG_XACT_COMMIT:
     416           0 :             id = "COMMIT";
     417           0 :             break;
     418           0 :         case XLOG_XACT_PREPARE:
     419           0 :             id = "PREPARE";
     420           0 :             break;
     421           0 :         case XLOG_XACT_ABORT:
     422           0 :             id = "ABORT";
     423           0 :             break;
     424           0 :         case XLOG_XACT_COMMIT_PREPARED:
     425           0 :             id = "COMMIT_PREPARED";
     426           0 :             break;
     427           0 :         case XLOG_XACT_ABORT_PREPARED:
     428           0 :             id = "ABORT_PREPARED";
     429           0 :             break;
     430           0 :         case XLOG_XACT_ASSIGNMENT:
     431           0 :             id = "ASSIGNMENT";
     432           0 :             break;
     433           0 :         case XLOG_XACT_INVALIDATIONS:
     434           0 :             id = "INVALIDATION";
     435           0 :             break;
     436             :     }
     437             : 
     438           0 :     return id;
     439             : }

Generated by: LCOV version 1.13