LCOV - code coverage report
Current view: top level - src/backend/access/heap - rewriteheap.c (source / functions) Hit Total Coverage
Test: PostgreSQL 17devel Lines: 259 311 83.3 %
Date: 2024-04-26 09:11:35 Functions: 11 12 91.7 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /*-------------------------------------------------------------------------
       2             :  *
       3             :  * rewriteheap.c
       4             :  *    Support functions to rewrite tables.
       5             :  *
       6             :  * These functions provide a facility to completely rewrite a heap, while
       7             :  * preserving visibility information and update chains.
       8             :  *
       9             :  * INTERFACE
      10             :  *
      11             :  * The caller is responsible for creating the new heap, all catalog
      12             :  * changes, supplying the tuples to be written to the new heap, and
      13             :  * rebuilding indexes.  The caller must hold AccessExclusiveLock on the
      14             :  * target table, because we assume no one else is writing into it.
      15             :  *
      16             :  * To use the facility:
      17             :  *
      18             :  * begin_heap_rewrite
      19             :  * while (fetch next tuple)
      20             :  * {
      21             :  *     if (tuple is dead)
      22             :  *         rewrite_heap_dead_tuple
      23             :  *     else
      24             :  *     {
      25             :  *         // do any transformations here if required
      26             :  *         rewrite_heap_tuple
      27             :  *     }
      28             :  * }
      29             :  * end_heap_rewrite
      30             :  *
      31             :  * The contents of the new relation shouldn't be relied on until after
      32             :  * end_heap_rewrite is called.
      33             :  *
      34             :  *
      35             :  * IMPLEMENTATION
      36             :  *
      37             :  * This would be a fairly trivial affair, except that we need to maintain
      38             :  * the ctid chains that link versions of an updated tuple together.
      39             :  * Since the newly stored tuples will have tids different from the original
      40             :  * ones, if we just copied t_ctid fields to the new table the links would
      41             :  * be wrong.  When we are required to copy a (presumably recently-dead or
      42             :  * delete-in-progress) tuple whose ctid doesn't point to itself, we have
      43             :  * to substitute the correct ctid instead.
      44             :  *
      45             :  * For each ctid reference from A -> B, we might encounter either A first
      46             :  * or B first.  (Note that a tuple in the middle of a chain is both A and B
      47             :  * of different pairs.)
      48             :  *
      49             :  * If we encounter A first, we'll store the tuple in the unresolved_tups
      50             :  * hash table. When we later encounter B, we remove A from the hash table,
      51             :  * fix the ctid to point to the new location of B, and insert both A and B
      52             :  * to the new heap.
      53             :  *
      54             :  * If we encounter B first, we can insert B to the new heap right away.
      55             :  * We then add an entry to the old_new_tid_map hash table showing B's
      56             :  * original tid (in the old heap) and new tid (in the new heap).
      57             :  * When we later encounter A, we get the new location of B from the table,
      58             :  * and can write A immediately with the correct ctid.
      59             :  *
      60             :  * Entries in the hash tables can be removed as soon as the later tuple
      61             :  * is encountered.  That helps to keep the memory usage down.  At the end,
      62             :  * both tables are usually empty; we should have encountered both A and B
      63             :  * of each pair.  However, it's possible for A to be RECENTLY_DEAD and B
      64             :  * entirely DEAD according to HeapTupleSatisfiesVacuum, because the test
      65             :  * for deadness using OldestXmin is not exact.  In such a case we might
      66             :  * encounter B first, and skip it, and find A later.  Then A would be added
      67             :  * to unresolved_tups, and stay there until end of the rewrite.  Since
      68             :  * this case is very unusual, we don't worry about the memory usage.
      69             :  *
      70             :  * Using in-memory hash tables means that we use some memory for each live
      71             :  * update chain in the table, from the time we find one end of the
      72             :  * reference until we find the other end.  That shouldn't be a problem in
      73             :  * practice, but if you do something like an UPDATE without a where-clause
      74             :  * on a large table, and then run CLUSTER in the same transaction, you
      75             :  * could run out of memory.  It doesn't seem worthwhile to add support for
      76             :  * spill-to-disk, as there shouldn't be that many RECENTLY_DEAD tuples in a
      77             :  * table under normal circumstances.  Furthermore, in the typical scenario
      78             :  * of CLUSTERing on an unchanging key column, we'll see all the versions
      79             :  * of a given tuple together anyway, and so the peak memory usage is only
      80             :  * proportional to the number of RECENTLY_DEAD versions of a single row, not
      81             :  * in the whole table.  Note that if we do fail halfway through a CLUSTER,
      82             :  * the old table is still valid, so failure is not catastrophic.
      83             :  *
      84             :  * We can't use the normal heap_insert function to insert into the new
      85             :  * heap, because heap_insert overwrites the visibility information.
      86             :  * We use a special-purpose raw_heap_insert function instead, which
      87             :  * is optimized for bulk inserting a lot of tuples, knowing that we have
      88             :  * exclusive access to the heap.  raw_heap_insert builds new pages in
      89             :  * local storage.  When a page is full, or at the end of the process,
      90             :  * we insert it to WAL as a single record and then write it to disk with
      91             :  * the bulk smgr writer.  Note, however, that any data sent to the new
      92             :  * heap's TOAST table will go through the normal bufmgr.
      93             :  *
      94             :  *
      95             :  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
      96             :  * Portions Copyright (c) 1994-5, Regents of the University of California
      97             :  *
      98             :  * IDENTIFICATION
      99             :  *    src/backend/access/heap/rewriteheap.c
     100             :  *
     101             :  *-------------------------------------------------------------------------
     102             :  */
     103             : #include "postgres.h"
     104             : 
     105             : #include <unistd.h>
     106             : 
     107             : #include "access/heapam.h"
     108             : #include "access/heapam_xlog.h"
     109             : #include "access/heaptoast.h"
     110             : #include "access/rewriteheap.h"
     111             : #include "access/transam.h"
     112             : #include "access/xact.h"
     113             : #include "access/xloginsert.h"
     114             : #include "common/file_utils.h"
     115             : #include "lib/ilist.h"
     116             : #include "miscadmin.h"
     117             : #include "pgstat.h"
     118             : #include "replication/slot.h"
     119             : #include "storage/bufmgr.h"
     120             : #include "storage/bulk_write.h"
     121             : #include "storage/fd.h"
     122             : #include "storage/procarray.h"
     123             : #include "utils/memutils.h"
     124             : #include "utils/rel.h"
     125             : 
     126             : /*
     127             :  * State associated with a rewrite operation. This is opaque to the user
     128             :  * of the rewrite facility.
     129             :  */
     130             : typedef struct RewriteStateData
     131             : {
     132             :     Relation    rs_old_rel;     /* source heap */
     133             :     Relation    rs_new_rel;     /* destination heap */
     134             :     BulkWriteState *rs_bulkstate;   /* writer for the destination */
     135             :     BulkWriteBuffer rs_buffer;  /* page currently being built */
     136             :     BlockNumber rs_blockno;     /* block where page will go */
     137             :     bool        rs_logical_rewrite; /* do we need to do logical rewriting */
     138             :     TransactionId rs_oldest_xmin;   /* oldest xmin used by caller to determine
     139             :                                      * tuple visibility */
     140             :     TransactionId rs_freeze_xid;    /* Xid that will be used as freeze cutoff
     141             :                                      * point */
     142             :     TransactionId rs_logical_xmin;  /* Xid that will be used as cutoff point
     143             :                                      * for logical rewrites */
     144             :     MultiXactId rs_cutoff_multi;    /* MultiXactId that will be used as cutoff
     145             :                                      * point for multixacts */
     146             :     MemoryContext rs_cxt;       /* for hash tables and entries and tuples in
     147             :                                  * them */
     148             :     XLogRecPtr  rs_begin_lsn;   /* XLogInsertLsn when starting the rewrite */
     149             :     HTAB       *rs_unresolved_tups; /* unmatched A tuples */
     150             :     HTAB       *rs_old_new_tid_map; /* unmatched B tuples */
     151             :     HTAB       *rs_logical_mappings;    /* logical remapping files */
     152             :     uint32      rs_num_rewrite_mappings;    /* # in memory mappings */
     153             : }           RewriteStateData;
     154             : 
     155             : /*
     156             :  * The lookup keys for the hash tables are tuple TID and xmin (we must check
     157             :  * both to avoid false matches from dead tuples).  Beware that there is
     158             :  * probably some padding space in this struct; it must be zeroed out for
     159             :  * correct hashtable operation.
     160             :  */
     161             : typedef struct
     162             : {
     163             :     TransactionId xmin;         /* tuple xmin */
     164             :     ItemPointerData tid;        /* tuple location in old heap */
     165             : } TidHashKey;
     166             : 
     167             : /*
     168             :  * Entry structures for the hash tables
     169             :  */
     170             : typedef struct
     171             : {
     172             :     TidHashKey  key;            /* expected xmin/old location of B tuple */
     173             :     ItemPointerData old_tid;    /* A's location in the old heap */
     174             :     HeapTuple   tuple;          /* A's tuple contents */
     175             : } UnresolvedTupData;
     176             : 
     177             : typedef UnresolvedTupData *UnresolvedTup;
     178             : 
     179             : typedef struct
     180             : {
     181             :     TidHashKey  key;            /* actual xmin/old location of B tuple */
     182             :     ItemPointerData new_tid;    /* where we put it in the new heap */
     183             : } OldToNewMappingData;
     184             : 
     185             : typedef OldToNewMappingData *OldToNewMapping;
     186             : 
     187             : /*
     188             :  * In-Memory data for an xid that might need logical remapping entries
     189             :  * to be logged.
     190             :  */
     191             : typedef struct RewriteMappingFile
     192             : {
     193             :     TransactionId xid;          /* xid that might need to see the row */
     194             :     int         vfd;            /* fd of mappings file */
     195             :     off_t       off;            /* how far have we written yet */
     196             :     dclist_head mappings;       /* list of in-memory mappings */
     197             :     char        path[MAXPGPATH];    /* path, for error messages */
     198             : } RewriteMappingFile;
     199             : 
     200             : /*
     201             :  * A single In-Memory logical rewrite mapping, hanging off
     202             :  * RewriteMappingFile->mappings.
     203             :  */
     204             : typedef struct RewriteMappingDataEntry
     205             : {
     206             :     LogicalRewriteMappingData map;  /* map between old and new location of the
     207             :                                      * tuple */
     208             :     dlist_node  node;
     209             : } RewriteMappingDataEntry;
     210             : 
     211             : 
     212             : /* prototypes for internal functions */
     213             : static void raw_heap_insert(RewriteState state, HeapTuple tup);
     214             : 
     215             : /* internal logical remapping prototypes */
     216             : static void logical_begin_heap_rewrite(RewriteState state);
     217             : static void logical_rewrite_heap_tuple(RewriteState state, ItemPointerData old_tid, HeapTuple new_tuple);
     218             : static void logical_end_heap_rewrite(RewriteState state);
     219             : 
     220             : 
     221             : /*
     222             :  * Begin a rewrite of a table
     223             :  *
     224             :  * old_heap     old, locked heap relation tuples will be read from
     225             :  * new_heap     new, locked heap relation to insert tuples to
     226             :  * oldest_xmin  xid used by the caller to determine which tuples are dead
     227             :  * freeze_xid   xid before which tuples will be frozen
     228             :  * cutoff_multi multixact before which multis will be removed
     229             :  *
     230             :  * Returns an opaque RewriteState, allocated in current memory context,
     231             :  * to be used in subsequent calls to the other functions.
     232             :  */
     233             : RewriteState
     234         526 : begin_heap_rewrite(Relation old_heap, Relation new_heap, TransactionId oldest_xmin,
     235             :                    TransactionId freeze_xid, MultiXactId cutoff_multi)
     236             : {
     237             :     RewriteState state;
     238             :     MemoryContext rw_cxt;
     239             :     MemoryContext old_cxt;
     240             :     HASHCTL     hash_ctl;
     241             : 
     242             :     /*
     243             :      * To ease cleanup, make a separate context that will contain the
     244             :      * RewriteState struct itself plus all subsidiary data.
     245             :      */
     246         526 :     rw_cxt = AllocSetContextCreate(CurrentMemoryContext,
     247             :                                    "Table rewrite",
     248             :                                    ALLOCSET_DEFAULT_SIZES);
     249         526 :     old_cxt = MemoryContextSwitchTo(rw_cxt);
     250             : 
     251             :     /* Create and fill in the state struct */
     252         526 :     state = palloc0(sizeof(RewriteStateData));
     253             : 
     254         526 :     state->rs_old_rel = old_heap;
     255         526 :     state->rs_new_rel = new_heap;
     256         526 :     state->rs_buffer = NULL;
     257             :     /* new_heap needn't be empty, just locked */
     258         526 :     state->rs_blockno = RelationGetNumberOfBlocks(new_heap);
     259         526 :     state->rs_oldest_xmin = oldest_xmin;
     260         526 :     state->rs_freeze_xid = freeze_xid;
     261         526 :     state->rs_cutoff_multi = cutoff_multi;
     262         526 :     state->rs_cxt = rw_cxt;
     263         526 :     state->rs_bulkstate = smgr_bulk_start_rel(new_heap, MAIN_FORKNUM);
     264             : 
     265             :     /* Initialize hash tables used to track update chains */
     266         526 :     hash_ctl.keysize = sizeof(TidHashKey);
     267         526 :     hash_ctl.entrysize = sizeof(UnresolvedTupData);
     268         526 :     hash_ctl.hcxt = state->rs_cxt;
     269             : 
     270         526 :     state->rs_unresolved_tups =
     271         526 :         hash_create("Rewrite / Unresolved ctids",
     272             :                     128,        /* arbitrary initial size */
     273             :                     &hash_ctl,
     274             :                     HASH_ELEM | HASH_BLOBS | HASH_CONTEXT);
     275             : 
     276         526 :     hash_ctl.entrysize = sizeof(OldToNewMappingData);
     277             : 
     278         526 :     state->rs_old_new_tid_map =
     279         526 :         hash_create("Rewrite / Old to new tid map",
     280             :                     128,        /* arbitrary initial size */
     281             :                     &hash_ctl,
     282             :                     HASH_ELEM | HASH_BLOBS | HASH_CONTEXT);
     283             : 
     284         526 :     MemoryContextSwitchTo(old_cxt);
     285             : 
     286         526 :     logical_begin_heap_rewrite(state);
     287             : 
     288         526 :     return state;
     289             : }
     290             : 
     291             : /*
     292             :  * End a rewrite.
     293             :  *
     294             :  * state and any other resources are freed.
     295             :  */
     296             : void
     297         526 : end_heap_rewrite(RewriteState state)
     298             : {
     299             :     HASH_SEQ_STATUS seq_status;
     300             :     UnresolvedTup unresolved;
     301             : 
     302             :     /*
     303             :      * Write any remaining tuples in the UnresolvedTups table. If we have any
     304             :      * left, they should in fact be dead, but let's err on the safe side.
     305             :      */
     306         526 :     hash_seq_init(&seq_status, state->rs_unresolved_tups);
     307             : 
     308         526 :     while ((unresolved = hash_seq_search(&seq_status)) != NULL)
     309             :     {
     310           0 :         ItemPointerSetInvalid(&unresolved->tuple->t_data->t_ctid);
     311           0 :         raw_heap_insert(state, unresolved->tuple);
     312             :     }
     313             : 
     314             :     /* Write the last page, if any */
     315         526 :     if (state->rs_buffer)
     316             :     {
     317         360 :         smgr_bulk_write(state->rs_bulkstate, state->rs_blockno, state->rs_buffer, true);
     318         360 :         state->rs_buffer = NULL;
     319             :     }
     320             : 
     321         526 :     smgr_bulk_finish(state->rs_bulkstate);
     322             : 
     323         526 :     logical_end_heap_rewrite(state);
     324             : 
     325             :     /* Deleting the context frees everything */
     326         526 :     MemoryContextDelete(state->rs_cxt);
     327         526 : }
     328             : 
     329             : /*
     330             :  * Add a tuple to the new heap.
     331             :  *
     332             :  * Visibility information is copied from the original tuple, except that
     333             :  * we "freeze" very-old tuples.  Note that since we scribble on new_tuple,
     334             :  * it had better be temp storage not a pointer to the original tuple.
     335             :  *
     336             :  * state        opaque state as returned by begin_heap_rewrite
     337             :  * old_tuple    original tuple in the old heap
     338             :  * new_tuple    new, rewritten tuple to be inserted to new heap
     339             :  */
     340             : void
     341      742138 : rewrite_heap_tuple(RewriteState state,
     342             :                    HeapTuple old_tuple, HeapTuple new_tuple)
     343             : {
     344             :     MemoryContext old_cxt;
     345             :     ItemPointerData old_tid;
     346             :     TidHashKey  hashkey;
     347             :     bool        found;
     348             :     bool        free_new;
     349             : 
     350      742138 :     old_cxt = MemoryContextSwitchTo(state->rs_cxt);
     351             : 
     352             :     /*
     353             :      * Copy the original tuple's visibility information into new_tuple.
     354             :      *
     355             :      * XXX we might later need to copy some t_infomask2 bits, too? Right now,
     356             :      * we intentionally clear the HOT status bits.
     357             :      */
     358      742138 :     memcpy(&new_tuple->t_data->t_choice.t_heap,
     359      742138 :            &old_tuple->t_data->t_choice.t_heap,
     360             :            sizeof(HeapTupleFields));
     361             : 
     362      742138 :     new_tuple->t_data->t_infomask &= ~HEAP_XACT_MASK;
     363      742138 :     new_tuple->t_data->t_infomask2 &= ~HEAP2_XACT_MASK;
     364      742138 :     new_tuple->t_data->t_infomask |=
     365      742138 :         old_tuple->t_data->t_infomask & HEAP_XACT_MASK;
     366             : 
     367             :     /*
     368             :      * While we have our hands on the tuple, we may as well freeze any
     369             :      * eligible xmin or xmax, so that future VACUUM effort can be saved.
     370             :      */
     371      742138 :     heap_freeze_tuple(new_tuple->t_data,
     372      742138 :                       state->rs_old_rel->rd_rel->relfrozenxid,
     373      742138 :                       state->rs_old_rel->rd_rel->relminmxid,
     374             :                       state->rs_freeze_xid,
     375             :                       state->rs_cutoff_multi);
     376             : 
     377             :     /*
     378             :      * Invalid ctid means that ctid should point to the tuple itself. We'll
     379             :      * override it later if the tuple is part of an update chain.
     380             :      */
     381      742138 :     ItemPointerSetInvalid(&new_tuple->t_data->t_ctid);
     382             : 
     383             :     /*
     384             :      * If the tuple has been updated, check the old-to-new mapping hash table.
     385             :      */
     386      802218 :     if (!((old_tuple->t_data->t_infomask & HEAP_XMAX_INVALID) ||
     387       60080 :           HeapTupleHeaderIsOnlyLocked(old_tuple->t_data)) &&
     388       60080 :         !HeapTupleHeaderIndicatesMovedPartitions(old_tuple->t_data) &&
     389       60080 :         !(ItemPointerEquals(&(old_tuple->t_self),
     390       60080 :                             &(old_tuple->t_data->t_ctid))))
     391             :     {
     392             :         OldToNewMapping mapping;
     393             : 
     394         918 :         memset(&hashkey, 0, sizeof(hashkey));
     395         918 :         hashkey.xmin = HeapTupleHeaderGetUpdateXid(old_tuple->t_data);
     396         918 :         hashkey.tid = old_tuple->t_data->t_ctid;
     397             : 
     398             :         mapping = (OldToNewMapping)
     399         918 :             hash_search(state->rs_old_new_tid_map, &hashkey,
     400             :                         HASH_FIND, NULL);
     401             : 
     402         918 :         if (mapping != NULL)
     403             :         {
     404             :             /*
     405             :              * We've already copied the tuple that t_ctid points to, so we can
     406             :              * set the ctid of this tuple to point to the new location, and
     407             :              * insert it right away.
     408             :              */
     409         372 :             new_tuple->t_data->t_ctid = mapping->new_tid;
     410             : 
     411             :             /* We don't need the mapping entry anymore */
     412         372 :             hash_search(state->rs_old_new_tid_map, &hashkey,
     413             :                         HASH_REMOVE, &found);
     414             :             Assert(found);
     415             :         }
     416             :         else
     417             :         {
     418             :             /*
     419             :              * We haven't seen the tuple t_ctid points to yet. Stash this
     420             :              * tuple into unresolved_tups to be written later.
     421             :              */
     422             :             UnresolvedTup unresolved;
     423             : 
     424         546 :             unresolved = hash_search(state->rs_unresolved_tups, &hashkey,
     425             :                                      HASH_ENTER, &found);
     426             :             Assert(!found);
     427             : 
     428         546 :             unresolved->old_tid = old_tuple->t_self;
     429         546 :             unresolved->tuple = heap_copytuple(new_tuple);
     430             : 
     431             :             /*
     432             :              * We can't do anything more now, since we don't know where the
     433             :              * tuple will be written.
     434             :              */
     435         546 :             MemoryContextSwitchTo(old_cxt);
     436         546 :             return;
     437             :         }
     438             :     }
     439             : 
     440             :     /*
     441             :      * Now we will write the tuple, and then check to see if it is the B tuple
     442             :      * in any new or known pair.  When we resolve a known pair, we will be
     443             :      * able to write that pair's A tuple, and then we have to check if it
     444             :      * resolves some other pair.  Hence, we need a loop here.
     445             :      */
     446      741592 :     old_tid = old_tuple->t_self;
     447      741592 :     free_new = false;
     448             : 
     449             :     for (;;)
     450         546 :     {
     451             :         ItemPointerData new_tid;
     452             : 
     453             :         /* Insert the tuple and find out where it's put in new_heap */
     454      742138 :         raw_heap_insert(state, new_tuple);
     455      742138 :         new_tid = new_tuple->t_self;
     456             : 
     457      742138 :         logical_rewrite_heap_tuple(state, old_tid, new_tuple);
     458             : 
     459             :         /*
     460             :          * If the tuple is the updated version of a row, and the prior version
     461             :          * wouldn't be DEAD yet, then we need to either resolve the prior
     462             :          * version (if it's waiting in rs_unresolved_tups), or make an entry
     463             :          * in rs_old_new_tid_map (so we can resolve it when we do see it). The
     464             :          * previous tuple's xmax would equal this one's xmin, so it's
     465             :          * RECENTLY_DEAD if and only if the xmin is not before OldestXmin.
     466             :          */
     467      742138 :         if ((new_tuple->t_data->t_infomask & HEAP_UPDATED) &&
     468       16168 :             !TransactionIdPrecedes(HeapTupleHeaderGetXmin(new_tuple->t_data),
     469             :                                    state->rs_oldest_xmin))
     470             :         {
     471             :             /*
     472             :              * Okay, this is B in an update pair.  See if we've seen A.
     473             :              */
     474             :             UnresolvedTup unresolved;
     475             : 
     476         918 :             memset(&hashkey, 0, sizeof(hashkey));
     477         918 :             hashkey.xmin = HeapTupleHeaderGetXmin(new_tuple->t_data);
     478         918 :             hashkey.tid = old_tid;
     479             : 
     480         918 :             unresolved = hash_search(state->rs_unresolved_tups, &hashkey,
     481             :                                      HASH_FIND, NULL);
     482             : 
     483         918 :             if (unresolved != NULL)
     484             :             {
     485             :                 /*
     486             :                  * We have seen and memorized the previous tuple already. Now
     487             :                  * that we know where we inserted the tuple its t_ctid points
     488             :                  * to, fix its t_ctid and insert it to the new heap.
     489             :                  */
     490         546 :                 if (free_new)
     491         156 :                     heap_freetuple(new_tuple);
     492         546 :                 new_tuple = unresolved->tuple;
     493         546 :                 free_new = true;
     494         546 :                 old_tid = unresolved->old_tid;
     495         546 :                 new_tuple->t_data->t_ctid = new_tid;
     496             : 
     497             :                 /*
     498             :                  * We don't need the hash entry anymore, but don't free its
     499             :                  * tuple just yet.
     500             :                  */
     501         546 :                 hash_search(state->rs_unresolved_tups, &hashkey,
     502             :                             HASH_REMOVE, &found);
     503             :                 Assert(found);
     504             : 
     505             :                 /* loop back to insert the previous tuple in the chain */
     506         546 :                 continue;
     507             :             }
     508             :             else
     509             :             {
     510             :                 /*
     511             :                  * Remember the new tid of this tuple. We'll use it to set the
     512             :                  * ctid when we find the previous tuple in the chain.
     513             :                  */
     514             :                 OldToNewMapping mapping;
     515             : 
     516         372 :                 mapping = hash_search(state->rs_old_new_tid_map, &hashkey,
     517             :                                       HASH_ENTER, &found);
     518             :                 Assert(!found);
     519             : 
     520         372 :                 mapping->new_tid = new_tid;
     521             :             }
     522             :         }
     523             : 
     524             :         /* Done with this (chain of) tuples, for now */
     525      741592 :         if (free_new)
     526         390 :             heap_freetuple(new_tuple);
     527      741592 :         break;
     528             :     }
     529             : 
     530      741592 :     MemoryContextSwitchTo(old_cxt);
     531             : }
     532             : 
     533             : /*
     534             :  * Register a dead tuple with an ongoing rewrite. Dead tuples are not
     535             :  * copied to the new table, but we still make note of them so that we
     536             :  * can release some resources earlier.
     537             :  *
     538             :  * Returns true if a tuple was removed from the unresolved_tups table.
     539             :  * This indicates that that tuple, previously thought to be "recently dead",
     540             :  * is now known really dead and won't be written to the output.
     541             :  */
     542             : bool
     543       10998 : rewrite_heap_dead_tuple(RewriteState state, HeapTuple old_tuple)
     544             : {
     545             :     /*
     546             :      * If we have already seen an earlier tuple in the update chain that
     547             :      * points to this tuple, let's forget about that earlier tuple. It's in
     548             :      * fact dead as well, our simple xmax < OldestXmin test in
     549             :      * HeapTupleSatisfiesVacuum just wasn't enough to detect it. It happens
     550             :      * when xmin of a tuple is greater than xmax, which sounds
     551             :      * counter-intuitive but is perfectly valid.
     552             :      *
     553             :      * We don't bother to try to detect the situation the other way round,
     554             :      * when we encounter the dead tuple first and then the recently dead one
     555             :      * that points to it. If that happens, we'll have some unmatched entries
     556             :      * in the UnresolvedTups hash table at the end. That can happen anyway,
     557             :      * because a vacuum might have removed the dead tuple in the chain before
     558             :      * us.
     559             :      */
     560             :     UnresolvedTup unresolved;
     561             :     TidHashKey  hashkey;
     562             :     bool        found;
     563             : 
     564       10998 :     memset(&hashkey, 0, sizeof(hashkey));
     565       10998 :     hashkey.xmin = HeapTupleHeaderGetXmin(old_tuple->t_data);
     566       10998 :     hashkey.tid = old_tuple->t_self;
     567             : 
     568       10998 :     unresolved = hash_search(state->rs_unresolved_tups, &hashkey,
     569             :                              HASH_FIND, NULL);
     570             : 
     571       10998 :     if (unresolved != NULL)
     572             :     {
     573             :         /* Need to free the contained tuple as well as the hashtable entry */
     574           0 :         heap_freetuple(unresolved->tuple);
     575           0 :         hash_search(state->rs_unresolved_tups, &hashkey,
     576             :                     HASH_REMOVE, &found);
     577             :         Assert(found);
     578           0 :         return true;
     579             :     }
     580             : 
     581       10998 :     return false;
     582             : }
     583             : 
     584             : /*
     585             :  * Insert a tuple to the new relation.  This has to track heap_insert
     586             :  * and its subsidiary functions!
     587             :  *
     588             :  * t_self of the tuple is set to the new TID of the tuple. If t_ctid of the
     589             :  * tuple is invalid on entry, it's replaced with the new TID as well (in
     590             :  * the inserted data only, not in the caller's copy).
     591             :  */
     592             : static void
     593      742138 : raw_heap_insert(RewriteState state, HeapTuple tup)
     594             : {
     595             :     Page        page;
     596             :     Size        pageFreeSpace,
     597             :                 saveFreeSpace;
     598             :     Size        len;
     599             :     OffsetNumber newoff;
     600             :     HeapTuple   heaptup;
     601             : 
     602             :     /*
     603             :      * If the new tuple is too big for storage or contains already toasted
     604             :      * out-of-line attributes from some other relation, invoke the toaster.
     605             :      *
     606             :      * Note: below this point, heaptup is the data we actually intend to store
     607             :      * into the relation; tup is the caller's original untoasted data.
     608             :      */
     609      742138 :     if (state->rs_new_rel->rd_rel->relkind == RELKIND_TOASTVALUE)
     610             :     {
     611             :         /* toast table entries should never be recursively toasted */
     612             :         Assert(!HeapTupleHasExternal(tup));
     613           0 :         heaptup = tup;
     614             :     }
     615      742138 :     else if (HeapTupleHasExternal(tup) || tup->t_len > TOAST_TUPLE_THRESHOLD)
     616         578 :     {
     617         578 :         int         options = HEAP_INSERT_SKIP_FSM;
     618             : 
     619             :         /*
     620             :          * While rewriting the heap for VACUUM FULL / CLUSTER, make sure data
     621             :          * for the TOAST table are not logically decoded.  The main heap is
     622             :          * WAL-logged as XLOG FPI records, which are not logically decoded.
     623             :          */
     624         578 :         options |= HEAP_INSERT_NO_LOGICAL;
     625             : 
     626         578 :         heaptup = heap_toast_insert_or_update(state->rs_new_rel, tup, NULL,
     627             :                                               options);
     628             :     }
     629             :     else
     630      741560 :         heaptup = tup;
     631             : 
     632      742138 :     len = MAXALIGN(heaptup->t_len); /* be conservative */
     633             : 
     634             :     /*
     635             :      * If we're gonna fail for oversize tuple, do it right away
     636             :      */
     637      742138 :     if (len > MaxHeapTupleSize)
     638           0 :         ereport(ERROR,
     639             :                 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
     640             :                  errmsg("row is too big: size %zu, maximum size %zu",
     641             :                         len, MaxHeapTupleSize)));
     642             : 
     643             :     /* Compute desired extra freespace due to fillfactor option */
     644      742138 :     saveFreeSpace = RelationGetTargetPageFreeSpace(state->rs_new_rel,
     645             :                                                    HEAP_DEFAULT_FILLFACTOR);
     646             : 
     647             :     /* Now we can check to see if there's enough free space already. */
     648      742138 :     page = (Page) state->rs_buffer;
     649      742138 :     if (page)
     650             :     {
     651      741778 :         pageFreeSpace = PageGetHeapFreeSpace(page);
     652             : 
     653      741778 :         if (len + saveFreeSpace > pageFreeSpace)
     654             :         {
     655             :             /*
     656             :              * Doesn't fit, so write out the existing page.  It always
     657             :              * contains a tuple.  Hence, unlike RelationGetBufferForTuple(),
     658             :              * enforce saveFreeSpace unconditionally.
     659             :              */
     660       10164 :             smgr_bulk_write(state->rs_bulkstate, state->rs_blockno, state->rs_buffer, true);
     661       10164 :             state->rs_buffer = NULL;
     662       10164 :             page = NULL;
     663       10164 :             state->rs_blockno++;
     664             :         }
     665             :     }
     666             : 
     667      742138 :     if (!page)
     668             :     {
     669             :         /* Initialize a new empty page */
     670       10524 :         state->rs_buffer = smgr_bulk_get_buf(state->rs_bulkstate);
     671       10524 :         page = (Page) state->rs_buffer;
     672       10524 :         PageInit(page, BLCKSZ, 0);
     673             :     }
     674             : 
     675             :     /* And now we can insert the tuple into the page */
     676      742138 :     newoff = PageAddItem(page, (Item) heaptup->t_data, heaptup->t_len,
     677             :                          InvalidOffsetNumber, false, true);
     678      742138 :     if (newoff == InvalidOffsetNumber)
     679           0 :         elog(ERROR, "failed to add tuple");
     680             : 
     681             :     /* Update caller's t_self to the actual position where it was stored */
     682      742138 :     ItemPointerSet(&(tup->t_self), state->rs_blockno, newoff);
     683             : 
     684             :     /*
     685             :      * Insert the correct position into CTID of the stored tuple, too, if the
     686             :      * caller didn't supply a valid CTID.
     687             :      */
     688      742138 :     if (!ItemPointerIsValid(&tup->t_data->t_ctid))
     689             :     {
     690             :         ItemId      newitemid;
     691             :         HeapTupleHeader onpage_tup;
     692             : 
     693      741220 :         newitemid = PageGetItemId(page, newoff);
     694      741220 :         onpage_tup = (HeapTupleHeader) PageGetItem(page, newitemid);
     695             : 
     696      741220 :         onpage_tup->t_ctid = tup->t_self;
     697             :     }
     698             : 
     699             :     /* If heaptup is a private copy, release it. */
     700      742138 :     if (heaptup != tup)
     701         578 :         heap_freetuple(heaptup);
     702      742138 : }
     703             : 
     704             : /* ------------------------------------------------------------------------
     705             :  * Logical rewrite support
     706             :  *
     707             :  * When doing logical decoding - which relies on using cmin/cmax of catalog
     708             :  * tuples, via xl_heap_new_cid records - heap rewrites have to log enough
     709             :  * information to allow the decoding backend to update its internal mapping
     710             :  * of (relfilelocator,ctid) => (cmin, cmax) to be correct for the rewritten heap.
     711             :  *
     712             :  * For that, every time we find a tuple that's been modified in a catalog
     713             :  * relation within the xmin horizon of any decoding slot, we log a mapping
     714             :  * from the old to the new location.
     715             :  *
     716             :  * To deal with rewrites that abort the filename of a mapping file contains
     717             :  * the xid of the transaction performing the rewrite, which then can be
     718             :  * checked before being read in.
     719             :  *
     720             :  * For efficiency we don't immediately spill every single map mapping for a
     721             :  * row to disk but only do so in batches when we've collected several of them
     722             :  * in memory or when end_heap_rewrite() has been called.
     723             :  *
     724             :  * Crash-Safety: This module diverts from the usual patterns of doing WAL
     725             :  * since it cannot rely on checkpoint flushing out all buffers and thus
     726             :  * waiting for exclusive locks on buffers. Usually the XLogInsert() covering
     727             :  * buffer modifications is performed while the buffer(s) that are being
     728             :  * modified are exclusively locked guaranteeing that both the WAL record and
     729             :  * the modified heap are on either side of the checkpoint. But since the
     730             :  * mapping files we log aren't in shared_buffers that interlock doesn't work.
     731             :  *
     732             :  * Instead we simply write the mapping files out to disk, *before* the
     733             :  * XLogInsert() is performed. That guarantees that either the XLogInsert() is
     734             :  * inserted after the checkpoint's redo pointer or that the checkpoint (via
     735             :  * CheckPointLogicalRewriteHeap()) has flushed the (partial) mapping file to
     736             :  * disk. That leaves the tail end that has not yet been flushed open to
     737             :  * corruption, which is solved by including the current offset in the
     738             :  * xl_heap_rewrite_mapping records and truncating the mapping file to it
     739             :  * during replay. Every time a rewrite is finished all generated mapping files
     740             :  * are synced to disk.
     741             :  *
     742             :  * Note that if we were only concerned about crash safety we wouldn't have to
     743             :  * deal with WAL logging at all - an fsync() at the end of a rewrite would be
     744             :  * sufficient for crash safety. Any mapping that hasn't been safely flushed to
     745             :  * disk has to be by an aborted (explicitly or via a crash) transaction and is
     746             :  * ignored by virtue of the xid in its name being subject to a
     747             :  * TransactionDidCommit() check. But we want to support having standbys via
     748             :  * physical replication, both for availability and to do logical decoding
     749             :  * there.
     750             :  * ------------------------------------------------------------------------
     751             :  */
     752             : 
     753             : /*
     754             :  * Do preparations for logging logical mappings during a rewrite if
     755             :  * necessary. If we detect that we don't need to log anything we'll prevent
     756             :  * any further action by the various logical rewrite functions.
     757             :  */
     758             : static void
     759         526 : logical_begin_heap_rewrite(RewriteState state)
     760             : {
     761             :     HASHCTL     hash_ctl;
     762             :     TransactionId logical_xmin;
     763             : 
     764             :     /*
     765             :      * We only need to persist these mappings if the rewritten table can be
     766             :      * accessed during logical decoding, if not, we can skip doing any
     767             :      * additional work.
     768             :      */
     769         526 :     state->rs_logical_rewrite =
     770         526 :         RelationIsAccessibleInLogicalDecoding(state->rs_old_rel);
     771             : 
     772         526 :     if (!state->rs_logical_rewrite)
     773         486 :         return;
     774             : 
     775          44 :     ProcArrayGetReplicationSlotXmin(NULL, &logical_xmin);
     776             : 
     777             :     /*
     778             :      * If there are no logical slots in progress we don't need to do anything,
     779             :      * there cannot be any remappings for relevant rows yet. The relation's
     780             :      * lock protects us against races.
     781             :      */
     782          44 :     if (logical_xmin == InvalidTransactionId)
     783             :     {
     784           4 :         state->rs_logical_rewrite = false;
     785           4 :         return;
     786             :     }
     787             : 
     788          40 :     state->rs_logical_xmin = logical_xmin;
     789          40 :     state->rs_begin_lsn = GetXLogInsertRecPtr();
     790          40 :     state->rs_num_rewrite_mappings = 0;
     791             : 
     792          40 :     hash_ctl.keysize = sizeof(TransactionId);
     793          40 :     hash_ctl.entrysize = sizeof(RewriteMappingFile);
     794          40 :     hash_ctl.hcxt = state->rs_cxt;
     795             : 
     796          40 :     state->rs_logical_mappings =
     797          40 :         hash_create("Logical rewrite mapping",
     798             :                     128,        /* arbitrary initial size */
     799             :                     &hash_ctl,
     800             :                     HASH_ELEM | HASH_BLOBS | HASH_CONTEXT);
     801             : }
     802             : 
     803             : /*
     804             :  * Flush all logical in-memory mappings to disk, but don't fsync them yet.
     805             :  */
     806             : static void
     807          18 : logical_heap_rewrite_flush_mappings(RewriteState state)
     808             : {
     809             :     HASH_SEQ_STATUS seq_status;
     810             :     RewriteMappingFile *src;
     811             :     dlist_mutable_iter iter;
     812             : 
     813             :     Assert(state->rs_logical_rewrite);
     814             : 
     815             :     /* no logical rewrite in progress, no need to iterate over mappings */
     816          18 :     if (state->rs_num_rewrite_mappings == 0)
     817           0 :         return;
     818             : 
     819          18 :     elog(DEBUG1, "flushing %u logical rewrite mapping entries",
     820             :          state->rs_num_rewrite_mappings);
     821             : 
     822          18 :     hash_seq_init(&seq_status, state->rs_logical_mappings);
     823         196 :     while ((src = (RewriteMappingFile *) hash_seq_search(&seq_status)) != NULL)
     824             :     {
     825             :         char       *waldata;
     826             :         char       *waldata_start;
     827             :         xl_heap_rewrite_mapping xlrec;
     828             :         Oid         dboid;
     829             :         uint32      len;
     830             :         int         written;
     831         178 :         uint32      num_mappings = dclist_count(&src->mappings);
     832             : 
     833             :         /* this file hasn't got any new mappings */
     834         178 :         if (num_mappings == 0)
     835           0 :             continue;
     836             : 
     837         178 :         if (state->rs_old_rel->rd_rel->relisshared)
     838           0 :             dboid = InvalidOid;
     839             :         else
     840         178 :             dboid = MyDatabaseId;
     841             : 
     842         178 :         xlrec.num_mappings = num_mappings;
     843         178 :         xlrec.mapped_rel = RelationGetRelid(state->rs_old_rel);
     844         178 :         xlrec.mapped_xid = src->xid;
     845         178 :         xlrec.mapped_db = dboid;
     846         178 :         xlrec.offset = src->off;
     847         178 :         xlrec.start_lsn = state->rs_begin_lsn;
     848             : 
     849             :         /* write all mappings consecutively */
     850         178 :         len = num_mappings * sizeof(LogicalRewriteMappingData);
     851         178 :         waldata_start = waldata = palloc(len);
     852             : 
     853             :         /*
     854             :          * collect data we need to write out, but don't modify ondisk data yet
     855             :          */
     856        1496 :         dclist_foreach_modify(iter, &src->mappings)
     857             :         {
     858             :             RewriteMappingDataEntry *pmap;
     859             : 
     860        1318 :             pmap = dclist_container(RewriteMappingDataEntry, node, iter.cur);
     861             : 
     862        1318 :             memcpy(waldata, &pmap->map, sizeof(pmap->map));
     863        1318 :             waldata += sizeof(pmap->map);
     864             : 
     865             :             /* remove from the list and free */
     866        1318 :             dclist_delete_from(&src->mappings, &pmap->node);
     867        1318 :             pfree(pmap);
     868             : 
     869             :             /* update bookkeeping */
     870        1318 :             state->rs_num_rewrite_mappings--;
     871             :         }
     872             : 
     873             :         Assert(dclist_count(&src->mappings) == 0);
     874             :         Assert(waldata == waldata_start + len);
     875             : 
     876             :         /*
     877             :          * Note that we deviate from the usual WAL coding practices here,
     878             :          * check the above "Logical rewrite support" comment for reasoning.
     879             :          */
     880         178 :         written = FileWrite(src->vfd, waldata_start, len, src->off,
     881             :                             WAIT_EVENT_LOGICAL_REWRITE_WRITE);
     882         178 :         if (written != len)
     883           0 :             ereport(ERROR,
     884             :                     (errcode_for_file_access(),
     885             :                      errmsg("could not write to file \"%s\", wrote %d of %d: %m", src->path,
     886             :                             written, len)));
     887         178 :         src->off += len;
     888             : 
     889         178 :         XLogBeginInsert();
     890         178 :         XLogRegisterData((char *) (&xlrec), sizeof(xlrec));
     891         178 :         XLogRegisterData(waldata_start, len);
     892             : 
     893             :         /* write xlog record */
     894         178 :         XLogInsert(RM_HEAP2_ID, XLOG_HEAP2_REWRITE);
     895             : 
     896         178 :         pfree(waldata_start);
     897             :     }
     898             :     Assert(state->rs_num_rewrite_mappings == 0);
     899             : }
     900             : 
     901             : /*
     902             :  * Logical remapping part of end_heap_rewrite().
     903             :  */
     904             : static void
     905         526 : logical_end_heap_rewrite(RewriteState state)
     906             : {
     907             :     HASH_SEQ_STATUS seq_status;
     908             :     RewriteMappingFile *src;
     909             : 
     910             :     /* done, no logical rewrite in progress */
     911         526 :     if (!state->rs_logical_rewrite)
     912         486 :         return;
     913             : 
     914             :     /* writeout remaining in-memory entries */
     915          40 :     if (state->rs_num_rewrite_mappings > 0)
     916          18 :         logical_heap_rewrite_flush_mappings(state);
     917             : 
     918             :     /* Iterate over all mappings we have written and fsync the files. */
     919          40 :     hash_seq_init(&seq_status, state->rs_logical_mappings);
     920         218 :     while ((src = (RewriteMappingFile *) hash_seq_search(&seq_status)) != NULL)
     921             :     {
     922         178 :         if (FileSync(src->vfd, WAIT_EVENT_LOGICAL_REWRITE_SYNC) != 0)
     923           0 :             ereport(data_sync_elevel(ERROR),
     924             :                     (errcode_for_file_access(),
     925             :                      errmsg("could not fsync file \"%s\": %m", src->path)));
     926         178 :         FileClose(src->vfd);
     927             :     }
     928             :     /* memory context cleanup will deal with the rest */
     929             : }
     930             : 
     931             : /*
     932             :  * Log a single (old->new) mapping for 'xid'.
     933             :  */
     934             : static void
     935        1318 : logical_rewrite_log_mapping(RewriteState state, TransactionId xid,
     936             :                             LogicalRewriteMappingData *map)
     937             : {
     938             :     RewriteMappingFile *src;
     939             :     RewriteMappingDataEntry *pmap;
     940             :     Oid         relid;
     941             :     bool        found;
     942             : 
     943        1318 :     relid = RelationGetRelid(state->rs_old_rel);
     944             : 
     945             :     /* look for existing mappings for this 'mapped' xid */
     946        1318 :     src = hash_search(state->rs_logical_mappings, &xid,
     947             :                       HASH_ENTER, &found);
     948             : 
     949             :     /*
     950             :      * We haven't yet had the need to map anything for this xid, create
     951             :      * per-xid data structures.
     952             :      */
     953        1318 :     if (!found)
     954             :     {
     955             :         char        path[MAXPGPATH];
     956             :         Oid         dboid;
     957             : 
     958         178 :         if (state->rs_old_rel->rd_rel->relisshared)
     959           0 :             dboid = InvalidOid;
     960             :         else
     961         178 :             dboid = MyDatabaseId;
     962             : 
     963         178 :         snprintf(path, MAXPGPATH,
     964             :                  "pg_logical/mappings/" LOGICAL_REWRITE_FORMAT,
     965             :                  dboid, relid,
     966         178 :                  LSN_FORMAT_ARGS(state->rs_begin_lsn),
     967             :                  xid, GetCurrentTransactionId());
     968             : 
     969         178 :         dclist_init(&src->mappings);
     970         178 :         src->off = 0;
     971         178 :         memcpy(src->path, path, sizeof(path));
     972         178 :         src->vfd = PathNameOpenFile(path,
     973             :                                     O_CREAT | O_EXCL | O_WRONLY | PG_BINARY);
     974         178 :         if (src->vfd < 0)
     975           0 :             ereport(ERROR,
     976             :                     (errcode_for_file_access(),
     977             :                      errmsg("could not create file \"%s\": %m", path)));
     978             :     }
     979             : 
     980        1318 :     pmap = MemoryContextAlloc(state->rs_cxt,
     981             :                               sizeof(RewriteMappingDataEntry));
     982        1318 :     memcpy(&pmap->map, map, sizeof(LogicalRewriteMappingData));
     983        1318 :     dclist_push_tail(&src->mappings, &pmap->node);
     984        1318 :     state->rs_num_rewrite_mappings++;
     985             : 
     986             :     /*
     987             :      * Write out buffer every time we've too many in-memory entries across all
     988             :      * mapping files.
     989             :      */
     990        1318 :     if (state->rs_num_rewrite_mappings >= 1000 /* arbitrary number */ )
     991           0 :         logical_heap_rewrite_flush_mappings(state);
     992        1318 : }
     993             : 
     994             : /*
     995             :  * Perform logical remapping for a tuple that's mapped from old_tid to
     996             :  * new_tuple->t_self by rewrite_heap_tuple() if necessary for the tuple.
     997             :  */
     998             : static void
     999      742138 : logical_rewrite_heap_tuple(RewriteState state, ItemPointerData old_tid,
    1000             :                            HeapTuple new_tuple)
    1001             : {
    1002      742138 :     ItemPointerData new_tid = new_tuple->t_self;
    1003      742138 :     TransactionId cutoff = state->rs_logical_xmin;
    1004             :     TransactionId xmin;
    1005             :     TransactionId xmax;
    1006      742138 :     bool        do_log_xmin = false;
    1007      742138 :     bool        do_log_xmax = false;
    1008             :     LogicalRewriteMappingData map;
    1009             : 
    1010             :     /* no logical rewrite in progress, we don't need to log anything */
    1011      742138 :     if (!state->rs_logical_rewrite)
    1012      740850 :         return;
    1013             : 
    1014       52034 :     xmin = HeapTupleHeaderGetXmin(new_tuple->t_data);
    1015             :     /* use *GetUpdateXid to correctly deal with multixacts */
    1016       52034 :     xmax = HeapTupleHeaderGetUpdateXid(new_tuple->t_data);
    1017             : 
    1018             :     /*
    1019             :      * Log the mapping iff the tuple has been created recently.
    1020             :      */
    1021       52034 :     if (TransactionIdIsNormal(xmin) && !TransactionIdPrecedes(xmin, cutoff))
    1022         970 :         do_log_xmin = true;
    1023             : 
    1024       52034 :     if (!TransactionIdIsNormal(xmax))
    1025             :     {
    1026             :         /*
    1027             :          * no xmax is set, can't have any permanent ones, so this check is
    1028             :          * sufficient
    1029             :          */
    1030             :     }
    1031         904 :     else if (HEAP_XMAX_IS_LOCKED_ONLY(new_tuple->t_data->t_infomask))
    1032             :     {
    1033             :         /* only locked, we don't care */
    1034             :     }
    1035         904 :     else if (!TransactionIdPrecedes(xmax, cutoff))
    1036             :     {
    1037             :         /* tuple has been deleted recently, log */
    1038         904 :         do_log_xmax = true;
    1039             :     }
    1040             : 
    1041             :     /* if neither needs to be logged, we're done */
    1042       52034 :     if (!do_log_xmin && !do_log_xmax)
    1043       50746 :         return;
    1044             : 
    1045             :     /* fill out mapping information */
    1046        1288 :     map.old_locator = state->rs_old_rel->rd_locator;
    1047        1288 :     map.old_tid = old_tid;
    1048        1288 :     map.new_locator = state->rs_new_rel->rd_locator;
    1049        1288 :     map.new_tid = new_tid;
    1050             : 
    1051             :     /* ---
    1052             :      * Now persist the mapping for the individual xids that are affected. We
    1053             :      * need to log for both xmin and xmax if they aren't the same transaction
    1054             :      * since the mapping files are per "affected" xid.
    1055             :      * We don't muster all that much effort detecting whether xmin and xmax
    1056             :      * are actually the same transaction, we just check whether the xid is the
    1057             :      * same disregarding subtransactions. Logging too much is relatively
    1058             :      * harmless and we could never do the check fully since subtransaction
    1059             :      * data is thrown away during restarts.
    1060             :      * ---
    1061             :      */
    1062        1288 :     if (do_log_xmin)
    1063         970 :         logical_rewrite_log_mapping(state, xmin, &map);
    1064             :     /* separately log mapping for xmax unless it'd be redundant */
    1065        1288 :     if (do_log_xmax && !TransactionIdEquals(xmin, xmax))
    1066         348 :         logical_rewrite_log_mapping(state, xmax, &map);
    1067             : }
    1068             : 
    1069             : /*
    1070             :  * Replay XLOG_HEAP2_REWRITE records
    1071             :  */
    1072             : void
    1073           0 : heap_xlog_logical_rewrite(XLogReaderState *r)
    1074             : {
    1075             :     char        path[MAXPGPATH];
    1076             :     int         fd;
    1077             :     xl_heap_rewrite_mapping *xlrec;
    1078             :     uint32      len;
    1079             :     char       *data;
    1080             : 
    1081           0 :     xlrec = (xl_heap_rewrite_mapping *) XLogRecGetData(r);
    1082             : 
    1083           0 :     snprintf(path, MAXPGPATH,
    1084             :              "pg_logical/mappings/" LOGICAL_REWRITE_FORMAT,
    1085             :              xlrec->mapped_db, xlrec->mapped_rel,
    1086           0 :              LSN_FORMAT_ARGS(xlrec->start_lsn),
    1087           0 :              xlrec->mapped_xid, XLogRecGetXid(r));
    1088             : 
    1089           0 :     fd = OpenTransientFile(path,
    1090             :                            O_CREAT | O_WRONLY | PG_BINARY);
    1091           0 :     if (fd < 0)
    1092           0 :         ereport(ERROR,
    1093             :                 (errcode_for_file_access(),
    1094             :                  errmsg("could not create file \"%s\": %m", path)));
    1095             : 
    1096             :     /*
    1097             :      * Truncate all data that's not guaranteed to have been safely fsynced (by
    1098             :      * previous record or by the last checkpoint).
    1099             :      */
    1100           0 :     pgstat_report_wait_start(WAIT_EVENT_LOGICAL_REWRITE_TRUNCATE);
    1101           0 :     if (ftruncate(fd, xlrec->offset) != 0)
    1102           0 :         ereport(ERROR,
    1103             :                 (errcode_for_file_access(),
    1104             :                  errmsg("could not truncate file \"%s\" to %u: %m",
    1105             :                         path, (uint32) xlrec->offset)));
    1106           0 :     pgstat_report_wait_end();
    1107             : 
    1108           0 :     data = XLogRecGetData(r) + sizeof(*xlrec);
    1109             : 
    1110           0 :     len = xlrec->num_mappings * sizeof(LogicalRewriteMappingData);
    1111             : 
    1112             :     /* write out tail end of mapping file (again) */
    1113           0 :     errno = 0;
    1114           0 :     pgstat_report_wait_start(WAIT_EVENT_LOGICAL_REWRITE_MAPPING_WRITE);
    1115           0 :     if (pg_pwrite(fd, data, len, xlrec->offset) != len)
    1116             :     {
    1117             :         /* if write didn't set errno, assume problem is no disk space */
    1118           0 :         if (errno == 0)
    1119           0 :             errno = ENOSPC;
    1120           0 :         ereport(ERROR,
    1121             :                 (errcode_for_file_access(),
    1122             :                  errmsg("could not write to file \"%s\": %m", path)));
    1123             :     }
    1124           0 :     pgstat_report_wait_end();
    1125             : 
    1126             :     /*
    1127             :      * Now fsync all previously written data. We could improve things and only
    1128             :      * do this for the last write to a file, but the required bookkeeping
    1129             :      * doesn't seem worth the trouble.
    1130             :      */
    1131           0 :     pgstat_report_wait_start(WAIT_EVENT_LOGICAL_REWRITE_MAPPING_SYNC);
    1132           0 :     if (pg_fsync(fd) != 0)
    1133           0 :         ereport(data_sync_elevel(ERROR),
    1134             :                 (errcode_for_file_access(),
    1135             :                  errmsg("could not fsync file \"%s\": %m", path)));
    1136           0 :     pgstat_report_wait_end();
    1137             : 
    1138           0 :     if (CloseTransientFile(fd) != 0)
    1139           0 :         ereport(ERROR,
    1140             :                 (errcode_for_file_access(),
    1141             :                  errmsg("could not close file \"%s\": %m", path)));
    1142           0 : }
    1143             : 
    1144             : /* ---
    1145             :  * Perform a checkpoint for logical rewrite mappings
    1146             :  *
    1147             :  * This serves two tasks:
    1148             :  * 1) Remove all mappings not needed anymore based on the logical restart LSN
    1149             :  * 2) Flush all remaining mappings to disk, so that replay after a checkpoint
    1150             :  *    only has to deal with the parts of a mapping that have been written out
    1151             :  *    after the checkpoint started.
    1152             :  * ---
    1153             :  */
    1154             : void
    1155        1704 : CheckPointLogicalRewriteHeap(void)
    1156             : {
    1157             :     XLogRecPtr  cutoff;
    1158             :     XLogRecPtr  redo;
    1159             :     DIR        *mappings_dir;
    1160             :     struct dirent *mapping_de;
    1161             :     char        path[MAXPGPATH + 20];
    1162             : 
    1163             :     /*
    1164             :      * We start of with a minimum of the last redo pointer. No new decoding
    1165             :      * slot will start before that, so that's a safe upper bound for removal.
    1166             :      */
    1167        1704 :     redo = GetRedoRecPtr();
    1168             : 
    1169             :     /* now check for the restart ptrs from existing slots */
    1170        1704 :     cutoff = ReplicationSlotsComputeLogicalRestartLSN();
    1171             : 
    1172             :     /* don't start earlier than the restart lsn */
    1173        1704 :     if (cutoff != InvalidXLogRecPtr && redo < cutoff)
    1174           0 :         cutoff = redo;
    1175             : 
    1176        1704 :     mappings_dir = AllocateDir("pg_logical/mappings");
    1177        5468 :     while ((mapping_de = ReadDir(mappings_dir, "pg_logical/mappings")) != NULL)
    1178             :     {
    1179             :         Oid         dboid;
    1180             :         Oid         relid;
    1181             :         XLogRecPtr  lsn;
    1182             :         TransactionId rewrite_xid;
    1183             :         TransactionId create_xid;
    1184             :         uint32      hi,
    1185             :                     lo;
    1186             :         PGFileType  de_type;
    1187             : 
    1188        3764 :         if (strcmp(mapping_de->d_name, ".") == 0 ||
    1189        2060 :             strcmp(mapping_de->d_name, "..") == 0)
    1190        3408 :             continue;
    1191             : 
    1192         356 :         snprintf(path, sizeof(path), "pg_logical/mappings/%s", mapping_de->d_name);
    1193         356 :         de_type = get_dirent_type(path, mapping_de, false, DEBUG1);
    1194             : 
    1195         356 :         if (de_type != PGFILETYPE_ERROR && de_type != PGFILETYPE_REG)
    1196           0 :             continue;
    1197             : 
    1198             :         /* Skip over files that cannot be ours. */
    1199         356 :         if (strncmp(mapping_de->d_name, "map-", 4) != 0)
    1200           0 :             continue;
    1201             : 
    1202         356 :         if (sscanf(mapping_de->d_name, LOGICAL_REWRITE_FORMAT,
    1203             :                    &dboid, &relid, &hi, &lo, &rewrite_xid, &create_xid) != 6)
    1204           0 :             elog(ERROR, "could not parse filename \"%s\"", mapping_de->d_name);
    1205             : 
    1206         356 :         lsn = ((uint64) hi) << 32 | lo;
    1207             : 
    1208         356 :         if (lsn < cutoff || cutoff == InvalidXLogRecPtr)
    1209             :         {
    1210         178 :             elog(DEBUG1, "removing logical rewrite file \"%s\"", path);
    1211         178 :             if (unlink(path) < 0)
    1212           0 :                 ereport(ERROR,
    1213             :                         (errcode_for_file_access(),
    1214             :                          errmsg("could not remove file \"%s\": %m", path)));
    1215             :         }
    1216             :         else
    1217             :         {
    1218             :             /* on some operating systems fsyncing a file requires O_RDWR */
    1219         178 :             int         fd = OpenTransientFile(path, O_RDWR | PG_BINARY);
    1220             : 
    1221             :             /*
    1222             :              * The file cannot vanish due to concurrency since this function
    1223             :              * is the only one removing logical mappings and only one
    1224             :              * checkpoint can be in progress at a time.
    1225             :              */
    1226         178 :             if (fd < 0)
    1227           0 :                 ereport(ERROR,
    1228             :                         (errcode_for_file_access(),
    1229             :                          errmsg("could not open file \"%s\": %m", path)));
    1230             : 
    1231             :             /*
    1232             :              * We could try to avoid fsyncing files that either haven't
    1233             :              * changed or have only been created since the checkpoint's start,
    1234             :              * but it's currently not deemed worth the effort.
    1235             :              */
    1236         178 :             pgstat_report_wait_start(WAIT_EVENT_LOGICAL_REWRITE_CHECKPOINT_SYNC);
    1237         178 :             if (pg_fsync(fd) != 0)
    1238           0 :                 ereport(data_sync_elevel(ERROR),
    1239             :                         (errcode_for_file_access(),
    1240             :                          errmsg("could not fsync file \"%s\": %m", path)));
    1241         178 :             pgstat_report_wait_end();
    1242             : 
    1243         178 :             if (CloseTransientFile(fd) != 0)
    1244           0 :                 ereport(ERROR,
    1245             :                         (errcode_for_file_access(),
    1246             :                          errmsg("could not close file \"%s\": %m", path)));
    1247             :         }
    1248             :     }
    1249        1704 :     FreeDir(mappings_dir);
    1250             : 
    1251             :     /* persist directory entries to disk */
    1252        1704 :     fsync_fname("pg_logical/mappings", true);
    1253        1704 : }

Generated by: LCOV version 1.14