/src/postgres/src/backend/utils/cache/relmapper.c

Source
/*-------------------------------------------------------------------------
 *
 * relmapper.c
 *    Catalog-to-filenumber mapping
 *
 * For most tables, the physical file underlying the table is specified by
 * pg_class.relfilenode.  However, that obviously won't work for pg_class
 * itself, nor for the other "nailed" catalogs for which we have to be able
 * to set up working Relation entries without access to pg_class.  It also
 * does not work for shared catalogs, since there is no practical way to
 * update other databases' pg_class entries when relocating a shared catalog.
 * Therefore, for these special catalogs (henceforth referred to as "mapped
 * catalogs") we rely on a separately maintained file that shows the mapping
 * from catalog OIDs to filenumbers.  Each database has a map file for
 * its local mapped catalogs, and there is a separate map file for shared
 * catalogs.  Mapped catalogs have zero in their pg_class.relfilenode entries.
 *
 * Relocation of a normal table is committed (ie, the new physical file becomes
 * authoritative) when the pg_class row update commits.  For mapped catalogs,
 * the act of updating the map file is effectively commit of the relocation.
 * We postpone the file update till just before commit of the transaction
 * doing the rewrite, but there is necessarily a window between.  Therefore
 * mapped catalogs can only be relocated by operations such as VACUUM FULL
 * and CLUSTER, which make no transactionally-significant changes: it must be
 * safe for the new file to replace the old, even if the transaction itself
 * aborts.  An important factor here is that the indexes and toast table of
 * a mapped catalog must also be mapped, so that the rewrites/relocations of
 * all these files commit in a single map file update rather than being tied
 * to transaction commit.
 *
 * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
 *    src/backend/utils/cache/relmapper.c
 *
 *-------------------------------------------------------------------------
 */
#include "postgres.h"

#include <fcntl.h>
#include <sys/stat.h>
#include <unistd.h>

#include "access/xact.h"
#include "access/xlog.h"
#include "access/xloginsert.h"
#include "catalog/pg_tablespace.h"
#include "catalog/storage.h"
#include "miscadmin.h"
#include "pgstat.h"
#include "storage/fd.h"
#include "storage/lwlock.h"
#include "utils/inval.h"
#include "utils/relmapper.h"
#include "utils/wait_event.h"


/*
 * The map file is critical data: we have no automatic method for recovering
 * from loss or corruption of it.  We use a CRC so that we can detect
 * corruption.  Since the file might be more than one standard-size disk
 * sector in size, we cannot rely on overwrite-in-place. Instead, we generate
 * a new file and rename it into place, atomically replacing the original file.
 *
 * Entries in the mappings[] array are in no particular order.  We could
 * speed searching by insisting on OID order, but it really shouldn't be
 * worth the trouble given the intended size of the mapping sets.
 */
#define RELMAPPER_FILENAME    "pg_filenode.map"
#define RELMAPPER_TEMP_FILENAME "pg_filenode.map.tmp"

#define RELMAPPER_FILEMAGIC   0x592717  /* version ID value */

/*
 * There's no need for this constant to have any particular value, and we
 * can raise it as necessary if we end up with more mapped relations. For
 * now, we just pick a round number that is modestly larger than the expected
 * number of mappings.
 */
#define MAX_MAPPINGS      64

typedef struct RelMapping
{
  Oid     mapoid;     /* OID of a catalog */
  RelFileNumber mapfilenumber;  /* its rel file number */
} RelMapping;

typedef struct RelMapFile
{
  int32   magic;      /* always RELMAPPER_FILEMAGIC */
  int32   num_mappings; /* number of valid RelMapping entries */
  RelMapping  mappings[MAX_MAPPINGS];
  pg_crc32c crc;      /* CRC of all above */
} RelMapFile;

/*
 * State for serializing local and shared relmappings for parallel workers
 * (active states only).  See notes on active_* and pending_* updates state.
 */
typedef struct SerializedActiveRelMaps
{
  RelMapFile  active_shared_updates;
  RelMapFile  active_local_updates;
} SerializedActiveRelMaps;

/*
 * The currently known contents of the shared map file and our database's
 * local map file are stored here.  These can be reloaded from disk
 * immediately whenever we receive an update sinval message.
 */
static RelMapFile shared_map;
static RelMapFile local_map;

/*
 * We use the same RelMapFile data structure to track uncommitted local
 * changes in the mappings (but note the magic and crc fields are not made
 * valid in these variables).  Currently, map updates are not allowed within
 * subtransactions, so one set of transaction-level changes is sufficient.
 *
 * The active_xxx variables contain updates that are valid in our transaction
 * and should be honored by RelationMapOidToFilenumber.  The pending_xxx
 * variables contain updates we have been told about that aren't active yet;
 * they will become active at the next CommandCounterIncrement.  This setup
 * lets map updates act similarly to updates of pg_class rows, ie, they
 * become visible only at the next CommandCounterIncrement boundary.
 *
 * Active shared and active local updates are serialized by the parallel
 * infrastructure, and deserialized within parallel workers.
 */
static RelMapFile active_shared_updates;
static RelMapFile active_local_updates;
static RelMapFile pending_shared_updates;
static RelMapFile pending_local_updates;


/* non-export function prototypes */
static void apply_map_update(RelMapFile *map, Oid relationId,
               RelFileNumber fileNumber, bool add_okay);
static void merge_map_updates(RelMapFile *map, const RelMapFile *updates,
                bool add_okay);
static void load_relmap_file(bool shared, bool lock_held);
static void read_relmap_file(RelMapFile *map, char *dbpath, bool lock_held,
               int elevel);
static void write_relmap_file(RelMapFile *newmap, bool write_wal,
                bool send_sinval, bool preserve_files,
                Oid dbid, Oid tsid, const char *dbpath);
static void perform_relmap_update(bool shared, const RelMapFile *updates);


/*
 * RelationMapOidToFilenumber
 *
 * The raison d' etre ... given a relation OID, look up its filenumber.
 *
 * Although shared and local relation OIDs should never overlap, the caller
 * always knows which we need --- so pass that information to avoid useless
 * searching.
 *
 * Returns InvalidRelFileNumber if the OID is not known (which should never
 * happen, but the caller is in a better position to report a meaningful
 * error).
 */
RelFileNumber
RelationMapOidToFilenumber(Oid relationId, bool shared)
{
  const RelMapFile *map;
  int32   i;

  /* If there are active updates, believe those over the main maps */
  if (shared)
  {
    map = &active_shared_updates;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (relationId == map->mappings[i].mapoid)
        return map->mappings[i].mapfilenumber;
    }
    map = &shared_map;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (relationId == map->mappings[i].mapoid)
        return map->mappings[i].mapfilenumber;
    }
  }
  else
  {
    map = &active_local_updates;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (relationId == map->mappings[i].mapoid)
        return map->mappings[i].mapfilenumber;
    }
    map = &local_map;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (relationId == map->mappings[i].mapoid)
        return map->mappings[i].mapfilenumber;
    }
  }

  return InvalidRelFileNumber;
}

/*
 * RelationMapFilenumberToOid
 *
 * Do the reverse of the normal direction of mapping done in
 * RelationMapOidToFilenumber.
 *
 * This is not supposed to be used during normal running but rather for
 * information purposes when looking at the filesystem or xlog.
 *
 * Returns InvalidOid if the OID is not known; this can easily happen if the
 * relfilenumber doesn't pertain to a mapped relation.
 */
Oid
RelationMapFilenumberToOid(RelFileNumber filenumber, bool shared)
{
  const RelMapFile *map;
  int32   i;

  /* If there are active updates, believe those over the main maps */
  if (shared)
  {
    map = &active_shared_updates;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (filenumber == map->mappings[i].mapfilenumber)
        return map->mappings[i].mapoid;
    }
    map = &shared_map;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (filenumber == map->mappings[i].mapfilenumber)
        return map->mappings[i].mapoid;
    }
  }
  else
  {
    map = &active_local_updates;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (filenumber == map->mappings[i].mapfilenumber)
        return map->mappings[i].mapoid;
    }
    map = &local_map;
    for (i = 0; i < map->num_mappings; i++)
    {
      if (filenumber == map->mappings[i].mapfilenumber)
        return map->mappings[i].mapoid;
    }
  }

  return InvalidOid;
}

/*
 * RelationMapOidToFilenumberForDatabase
 *
 * Like RelationMapOidToFilenumber, but reads the mapping from the indicated
 * path instead of using the one for the current database.
 */
RelFileNumber
RelationMapOidToFilenumberForDatabase(char *dbpath, Oid relationId)
{
  RelMapFile  map;
  int     i;

  /* Read the relmap file from the source database. */
  read_relmap_file(&map, dbpath, false, ERROR);

  /* Iterate over the relmap entries to find the input relation OID. */
  for (i = 0; i < map.num_mappings; i++)
  {
    if (relationId == map.mappings[i].mapoid)
      return map.mappings[i].mapfilenumber;
  }

  return InvalidRelFileNumber;
}

/*
 * RelationMapCopy
 *
 * Copy relmapfile from source db path to the destination db path and WAL log
 * the operation. This is intended for use in creating a new relmap file
 * for a database that doesn't have one yet, not for replacing an existing
 * relmap file.
 */
void
RelationMapCopy(Oid dbid, Oid tsid, char *srcdbpath, char *dstdbpath)
{
  RelMapFile  map;

  /*
   * Read the relmap file from the source database.
   */
  read_relmap_file(&map, srcdbpath, false, ERROR);

  /*
   * Write the same data into the destination database's relmap file.
   *
   * No sinval is needed because no one can be connected to the destination
   * database yet.
   *
   * There's no point in trying to preserve files here. The new database
   * isn't usable yet anyway, and won't ever be if we can't install a relmap
   * file.
   */
  LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);
  write_relmap_file(&map, true, false, false, dbid, tsid, dstdbpath);
  LWLockRelease(RelationMappingLock);
}

/*
 * RelationMapUpdateMap
 *
 * Install a new relfilenumber mapping for the specified relation.
 *
 * If immediate is true (or we're bootstrapping), the mapping is activated
 * immediately.  Otherwise it is made pending until CommandCounterIncrement.
 */
void
RelationMapUpdateMap(Oid relationId, RelFileNumber fileNumber, bool shared,
           bool immediate)
{
  RelMapFile *map;

  if (IsBootstrapProcessingMode())
  {
    /*
     * In bootstrap mode, the mapping gets installed in permanent map.
     */
    if (shared)
      map = &shared_map;
    else
      map = &local_map;
  }
  else
  {
    /*
     * We don't currently support map changes within subtransactions, or
     * when in parallel mode.  This could be done with more bookkeeping
     * infrastructure, but it doesn't presently seem worth it.
     */
    if (GetCurrentTransactionNestLevel() > 1)
      elog(ERROR, "cannot change relation mapping within subtransaction");

    if (IsInParallelMode())
      elog(ERROR, "cannot change relation mapping in parallel mode");

    if (immediate)
    {
      /* Make it active, but only locally */
      if (shared)
        map = &active_shared_updates;
      else
        map = &active_local_updates;
    }
    else
    {
      /* Make it pending */
      if (shared)
        map = &pending_shared_updates;
      else
        map = &pending_local_updates;
    }
  }
  apply_map_update(map, relationId, fileNumber, true);
}

/*
 * apply_map_update
 *
 * Insert a new mapping into the given map variable, replacing any existing
 * mapping for the same relation.
 *
 * In some cases the caller knows there must be an existing mapping; pass
 * add_okay = false to draw an error if not.
 */
static void
apply_map_update(RelMapFile *map, Oid relationId, RelFileNumber fileNumber,
         bool add_okay)
{
  int32   i;

  /* Replace any existing mapping */
  for (i = 0; i < map->num_mappings; i++)
  {
    if (relationId == map->mappings[i].mapoid)
    {
      map->mappings[i].mapfilenumber = fileNumber;
      return;
    }
  }

  /* Nope, need to add a new mapping */
  if (!add_okay)
    elog(ERROR, "attempt to apply a mapping to unmapped relation %u",
       relationId);
  if (map->num_mappings >= MAX_MAPPINGS)
    elog(ERROR, "ran out of space in relation map");
  map->mappings[map->num_mappings].mapoid = relationId;
  map->mappings[map->num_mappings].mapfilenumber = fileNumber;
  map->num_mappings++;
}

/*
 * merge_map_updates
 *
 * Merge all the updates in the given pending-update map into the target map.
 * This is just a bulk form of apply_map_update.
 */
static void
merge_map_updates(RelMapFile *map, const RelMapFile *updates, bool add_okay)
{
  int32   i;

  for (i = 0; i < updates->num_mappings; i++)
  {
    apply_map_update(map,
             updates->mappings[i].mapoid,
             updates->mappings[i].mapfilenumber,
             add_okay);
  }
}

/*
 * RelationMapRemoveMapping
 *
 * Remove a relation's entry in the map.  This is only allowed for "active"
 * (but not committed) local mappings.  We need it so we can back out the
 * entry for the transient target file when doing VACUUM FULL/CLUSTER on
 * a mapped relation.
 */
void
RelationMapRemoveMapping(Oid relationId)
{
  RelMapFile *map = &active_local_updates;
  int32   i;

  for (i = 0; i < map->num_mappings; i++)
  {
    if (relationId == map->mappings[i].mapoid)
    {
      /* Found it, collapse it out */
      map->mappings[i] = map->mappings[map->num_mappings - 1];
      map->num_mappings--;
      return;
    }
  }
  elog(ERROR, "could not find temporary mapping for relation %u",
     relationId);
}

/*
 * RelationMapInvalidate
 *
 * This routine is invoked for SI cache flush messages.  We must re-read
 * the indicated map file.  However, we might receive a SI message in a
 * process that hasn't yet, and might never, load the mapping files;
 * for example the autovacuum launcher, which *must not* try to read
 * a local map since it is attached to no particular database.
 * So, re-read only if the map is valid now.
 */
void
RelationMapInvalidate(bool shared)
{
  if (shared)
  {
    if (shared_map.magic == RELMAPPER_FILEMAGIC)
      load_relmap_file(true, false);
  }
  else
  {
    if (local_map.magic == RELMAPPER_FILEMAGIC)
      load_relmap_file(false, false);
  }
}

/*
 * RelationMapInvalidateAll
 *
 * Reload all map files.  This is used to recover from SI message buffer
 * overflow: we can't be sure if we missed an inval message.
 * Again, reload only currently-valid maps.
 */
void
RelationMapInvalidateAll(void)
{
  if (shared_map.magic == RELMAPPER_FILEMAGIC)
    load_relmap_file(true, false);
  if (local_map.magic == RELMAPPER_FILEMAGIC)
    load_relmap_file(false, false);
}

/*
 * AtCCI_RelationMap
 *
 * Activate any "pending" relation map updates at CommandCounterIncrement time.
 */
void
AtCCI_RelationMap(void)
{
  if (pending_shared_updates.num_mappings != 0)
  {
    merge_map_updates(&active_shared_updates,
              &pending_shared_updates,
              true);
    pending_shared_updates.num_mappings = 0;
  }
  if (pending_local_updates.num_mappings != 0)
  {
    merge_map_updates(&active_local_updates,
              &pending_local_updates,
              true);
    pending_local_updates.num_mappings = 0;
  }
}

/*
 * AtEOXact_RelationMap
 *
 * Handle relation mapping at main-transaction commit or abort.
 *
 * During commit, this must be called as late as possible before the actual
 * transaction commit, so as to minimize the window where the transaction
 * could still roll back after committing map changes.  Although nothing
 * critically bad happens in such a case, we still would prefer that it
 * not happen, since we'd possibly be losing useful updates to the relations'
 * pg_class row(s).
 *
 * During abort, we just have to throw away any pending map changes.
 * Normal post-abort cleanup will take care of fixing relcache entries.
 * Parallel worker commit/abort is handled by resetting active mappings
 * that may have been received from the leader process.  (There should be
 * no pending updates in parallel workers.)
 */
void
AtEOXact_RelationMap(bool isCommit, bool isParallelWorker)
{
  if (isCommit && !isParallelWorker)
  {
    /*
     * We should not get here with any "pending" updates.  (We could
     * logically choose to treat such as committed, but in the current
     * code this should never happen.)
     */
    Assert(pending_shared_updates.num_mappings == 0);
    Assert(pending_local_updates.num_mappings == 0);

    /*
     * Write any active updates to the actual map files, then reset them.
     */
    if (active_shared_updates.num_mappings != 0)
    {
      perform_relmap_update(true, &active_shared_updates);
      active_shared_updates.num_mappings = 0;
    }
    if (active_local_updates.num_mappings != 0)
    {
      perform_relmap_update(false, &active_local_updates);
      active_local_updates.num_mappings = 0;
    }
  }
  else
  {
    /* Abort or parallel worker --- drop all local and pending updates */
    Assert(!isParallelWorker || pending_shared_updates.num_mappings == 0);
    Assert(!isParallelWorker || pending_local_updates.num_mappings == 0);

    active_shared_updates.num_mappings = 0;
    active_local_updates.num_mappings = 0;
    pending_shared_updates.num_mappings = 0;
    pending_local_updates.num_mappings = 0;
  }
}

/*
 * AtPrepare_RelationMap
 *
 * Handle relation mapping at PREPARE.
 *
 * Currently, we don't support preparing any transaction that changes the map.
 */
void
AtPrepare_RelationMap(void)
{
  if (active_shared_updates.num_mappings != 0 ||
    active_local_updates.num_mappings != 0 ||
    pending_shared_updates.num_mappings != 0 ||
    pending_local_updates.num_mappings != 0)
    ereport(ERROR,
        (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
         errmsg("cannot PREPARE a transaction that modified relation mapping")));
}

/*
 * CheckPointRelationMap
 *
 * This is called during a checkpoint.  It must ensure that any relation map
 * updates that were WAL-logged before the start of the checkpoint are
 * securely flushed to disk and will not need to be replayed later.  This
 * seems unlikely to be a performance-critical issue, so we use a simple
 * method: we just take and release the RelationMappingLock.  This ensures
 * that any already-logged map update is complete, because write_relmap_file
 * will fsync the map file before the lock is released.
 */
void
CheckPointRelationMap(void)
{
  LWLockAcquire(RelationMappingLock, LW_SHARED);
  LWLockRelease(RelationMappingLock);
}

/*
 * RelationMapFinishBootstrap
 *
 * Write out the initial relation mapping files at the completion of
 * bootstrap.  All the mapped files should have been made known to us
 * via RelationMapUpdateMap calls.
 */
void
RelationMapFinishBootstrap(void)
{
  Assert(IsBootstrapProcessingMode());

  /* Shouldn't be anything "pending" ... */
  Assert(active_shared_updates.num_mappings == 0);
  Assert(active_local_updates.num_mappings == 0);
  Assert(pending_shared_updates.num_mappings == 0);
  Assert(pending_local_updates.num_mappings == 0);

  /* Write the files; no WAL or sinval needed */
  LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);
  write_relmap_file(&shared_map, false, false, false,
            InvalidOid, GLOBALTABLESPACE_OID, "global");
  write_relmap_file(&local_map, false, false, false,
            MyDatabaseId, MyDatabaseTableSpace, DatabasePath);
  LWLockRelease(RelationMappingLock);
}

/*
 * RelationMapInitialize
 *
 * This initializes the mapper module at process startup.  We can't access the
 * database yet, so just make sure the maps are empty.
 */
void
RelationMapInitialize(void)
{
  /* The static variables should initialize to zeroes, but let's be sure */
  shared_map.magic = 0;   /* mark it not loaded */
  local_map.magic = 0;
  shared_map.num_mappings = 0;
  local_map.num_mappings = 0;
  active_shared_updates.num_mappings = 0;
  active_local_updates.num_mappings = 0;
  pending_shared_updates.num_mappings = 0;
  pending_local_updates.num_mappings = 0;
}

/*
 * RelationMapInitializePhase2
 *
 * This is called to prepare for access to pg_database during startup.
 * We should be able to read the shared map file now.
 */
void
RelationMapInitializePhase2(void)
{
  /*
   * In bootstrap mode, the map file isn't there yet, so do nothing.
   */
  if (IsBootstrapProcessingMode())
    return;

  /*
   * Load the shared map file, die on error.
   */
  load_relmap_file(true, false);
}

/*
 * RelationMapInitializePhase3
 *
 * This is called as soon as we have determined MyDatabaseId and set up
 * DatabasePath.  At this point we should be able to read the local map file.
 */
void
RelationMapInitializePhase3(void)
{
  /*
   * In bootstrap mode, the map file isn't there yet, so do nothing.
   */
  if (IsBootstrapProcessingMode())
    return;

  /*
   * Load the local map file, die on error.
   */
  load_relmap_file(false, false);
}

/*
 * EstimateRelationMapSpace
 *
 * Estimate space needed to pass active shared and local relmaps to parallel
 * workers.
 */
Size
EstimateRelationMapSpace(void)
{
  return sizeof(SerializedActiveRelMaps);
}

/*
 * SerializeRelationMap
 *
 * Serialize active shared and local relmap state for parallel workers.
 */
void
SerializeRelationMap(Size maxSize, char *startAddress)
{
  SerializedActiveRelMaps *relmaps;

  Assert(maxSize >= EstimateRelationMapSpace());

  relmaps = (SerializedActiveRelMaps *) startAddress;
  relmaps->active_shared_updates = active_shared_updates;
  relmaps->active_local_updates = active_local_updates;
}

/*
 * RestoreRelationMap
 *
 * Restore active shared and local relmap state within a parallel worker.
 */
void
RestoreRelationMap(char *startAddress)
{
  SerializedActiveRelMaps *relmaps;

  if (active_shared_updates.num_mappings != 0 ||
    active_local_updates.num_mappings != 0 ||
    pending_shared_updates.num_mappings != 0 ||
    pending_local_updates.num_mappings != 0)
    elog(ERROR, "parallel worker has existing mappings");

  relmaps = (SerializedActiveRelMaps *) startAddress;
  active_shared_updates = relmaps->active_shared_updates;
  active_local_updates = relmaps->active_local_updates;
}

/*
 * load_relmap_file -- load the shared or local map file
 *
 * Because these files are essential for access to core system catalogs,
 * failure to load either of them is a fatal error.
 *
 * Note that the local case requires DatabasePath to be set up.
 */
static void
load_relmap_file(bool shared, bool lock_held)
{
  if (shared)
    read_relmap_file(&shared_map, "global", lock_held, FATAL);
  else
    read_relmap_file(&local_map, DatabasePath, lock_held, FATAL);
}

/*
 * read_relmap_file -- load data from any relation mapper file
 *
 * dbpath must be the relevant database path, or "global" for shared relations.
 *
 * RelationMappingLock will be acquired released unless lock_held = true.
 *
 * Errors will be reported at the indicated elevel, which should be at least
 * ERROR.
 */
static void
read_relmap_file(RelMapFile *map, char *dbpath, bool lock_held, int elevel)
{
  char    mapfilename[MAXPGPATH];
  pg_crc32c crc;
  int     fd;
  ssize_t   r;

  Assert(elevel >= ERROR);

  /*
   * Grab the lock to prevent the file from being updated while we read it,
   * unless the caller is already holding the lock.  If the file is updated
   * shortly after we look, the sinval signaling mechanism will make us
   * re-read it before we are able to access any relation that's affected by
   * the change.
   */
  if (!lock_held)
    LWLockAcquire(RelationMappingLock, LW_SHARED);

  /*
   * Open the target file.
   *
   * Because Windows isn't happy about the idea of renaming over a file that
   * someone has open, we only open this file after acquiring the lock, and
   * for the same reason, we close it before releasing the lock. That way,
   * by the time write_relmap_file() acquires an exclusive lock, no one else
   * will have it open.
   */
  snprintf(mapfilename, sizeof(mapfilename), "%s/%s", dbpath,
       RELMAPPER_FILENAME);
  fd = OpenTransientFile(mapfilename, O_RDONLY | PG_BINARY);
  if (fd < 0)
    ereport(elevel,
        (errcode_for_file_access(),
         errmsg("could not open file \"%s\": %m",
            mapfilename)));

  /* Now read the data. */
  pgstat_report_wait_start(WAIT_EVENT_RELATION_MAP_READ);
  r = read(fd, map, sizeof(RelMapFile));
  if (r != sizeof(RelMapFile))
  {
    if (r < 0)
      ereport(elevel,
          (errcode_for_file_access(),
           errmsg("could not read file \"%s\": %m", mapfilename)));
    else
      ereport(elevel,
          (errcode(ERRCODE_DATA_CORRUPTED),
           errmsg("could not read file \"%s\": read %zd of %zu",
              mapfilename, r, sizeof(RelMapFile))));
  }
  pgstat_report_wait_end();

  if (CloseTransientFile(fd) != 0)
    ereport(elevel,
        (errcode_for_file_access(),
         errmsg("could not close file \"%s\": %m",
            mapfilename)));

  if (!lock_held)
    LWLockRelease(RelationMappingLock);

  /* check for correct magic number, etc */
  if (map->magic != RELMAPPER_FILEMAGIC ||
    map->num_mappings < 0 ||
    map->num_mappings > MAX_MAPPINGS)
    ereport(elevel,
        (errmsg("relation mapping file \"%s\" contains invalid data",
            mapfilename)));

  /* verify the CRC */
  INIT_CRC32C(crc);
  COMP_CRC32C(crc, map, offsetof(RelMapFile, crc));
  FIN_CRC32C(crc);

  if (!EQ_CRC32C(crc, map->crc))
    ereport(elevel,
        (errmsg("relation mapping file \"%s\" contains incorrect checksum",
            mapfilename)));
}

/*
 * Write out a new shared or local map file with the given contents.
 *
 * The magic number and CRC are automatically updated in *newmap.  On
 * success, we copy the data to the appropriate permanent static variable.
 *
 * If write_wal is true then an appropriate WAL message is emitted.
 * (It will be false for bootstrap and WAL replay cases.)
 *
 * If send_sinval is true then a SI invalidation message is sent.
 * (This should be true except in bootstrap case.)
 *
 * If preserve_files is true then the storage manager is warned not to
 * delete the files listed in the map.
 *
 * Because this may be called during WAL replay when MyDatabaseId,
 * DatabasePath, etc aren't valid, we require the caller to pass in suitable
 * values. Pass dbpath as "global" for the shared map.
 *
 * The caller is also responsible for being sure no concurrent map update
 * could be happening.
 */
static void
write_relmap_file(RelMapFile *newmap, bool write_wal, bool send_sinval,
          bool preserve_files, Oid dbid, Oid tsid, const char *dbpath)
{
  int     fd;
  char    mapfilename[MAXPGPATH];
  char    maptempfilename[MAXPGPATH];

  /*
   * Even without concurrent use of this map, CheckPointRelationMap() relies
   * on this locking.  Without it, a restore of a base backup taken after
   * this function's XLogInsert() and before its durable_rename() would not
   * have the changes.  wal_level=minimal doesn't need the lock, but this
   * isn't performance-critical enough for such a micro-optimization.
   */
  Assert(LWLockHeldByMeInMode(RelationMappingLock, LW_EXCLUSIVE));

  /*
   * Fill in the overhead fields and update CRC.
   */
  newmap->magic = RELMAPPER_FILEMAGIC;
  if (newmap->num_mappings < 0 || newmap->num_mappings > MAX_MAPPINGS)
    elog(ERROR, "attempt to write bogus relation mapping");

  INIT_CRC32C(newmap->crc);
  COMP_CRC32C(newmap->crc, newmap, offsetof(RelMapFile, crc));
  FIN_CRC32C(newmap->crc);

  /*
   * Construct filenames -- a temporary file that we'll create to write the
   * data initially, and then the permanent name to which we will rename it.
   */
  snprintf(mapfilename, sizeof(mapfilename), "%s/%s",
       dbpath, RELMAPPER_FILENAME);
  snprintf(maptempfilename, sizeof(maptempfilename), "%s/%s",
       dbpath, RELMAPPER_TEMP_FILENAME);

  /*
   * Open a temporary file. If a file already exists with this name, it must
   * be left over from a previous crash, so we can overwrite it. Concurrent
   * calls to this function are not allowed.
   */
  fd = OpenTransientFile(maptempfilename,
               O_WRONLY | O_CREAT | O_TRUNC | PG_BINARY);
  if (fd < 0)
    ereport(ERROR,
        (errcode_for_file_access(),
         errmsg("could not open file \"%s\": %m",
            maptempfilename)));

  /* Write new data to the file. */
  pgstat_report_wait_start(WAIT_EVENT_RELATION_MAP_WRITE);
  if (write(fd, newmap, sizeof(RelMapFile)) != sizeof(RelMapFile))
  {
    /* if write didn't set errno, assume problem is no disk space */
    if (errno == 0)
      errno = ENOSPC;
    ereport(ERROR,
        (errcode_for_file_access(),
         errmsg("could not write file \"%s\": %m",
            maptempfilename)));
  }
  pgstat_report_wait_end();

  /* And close the file. */
  if (CloseTransientFile(fd) != 0)
    ereport(ERROR,
        (errcode_for_file_access(),
         errmsg("could not close file \"%s\": %m",
            maptempfilename)));

  if (write_wal)
  {
    xl_relmap_update xlrec;
    XLogRecPtr  lsn;

    /* now errors are fatal ... */
    START_CRIT_SECTION();

    xlrec.dbid = dbid;
    xlrec.tsid = tsid;
    xlrec.nbytes = sizeof(RelMapFile);

    XLogBeginInsert();
    XLogRegisterData(&xlrec, MinSizeOfRelmapUpdate);
    XLogRegisterData(newmap, sizeof(RelMapFile));

    lsn = XLogInsert(RM_RELMAP_ID, XLOG_RELMAP_UPDATE);

    /* As always, WAL must hit the disk before the data update does */
    XLogFlush(lsn);
  }

  /*
   * durable_rename() does all the hard work of making sure that we rename
   * the temporary file into place in a crash-safe manner.
   *
   * NB: Although we instruct durable_rename() to use ERROR, we will often
   * be in a critical section at this point; if so, ERROR will become PANIC.
   */
  pgstat_report_wait_start(WAIT_EVENT_RELATION_MAP_REPLACE);
  durable_rename(maptempfilename, mapfilename, ERROR);
  pgstat_report_wait_end();

  /*
   * Now that the file is safely on disk, send sinval message to let other
   * backends know to re-read it.  We must do this inside the critical
   * section: if for some reason we fail to send the message, we have to
   * force a database-wide PANIC.  Otherwise other backends might continue
   * execution with stale mapping information, which would be catastrophic
   * as soon as others began to use the now-committed data.
   */
  if (send_sinval)
    CacheInvalidateRelmap(dbid);

  /*
   * Make sure that the files listed in the map are not deleted if the outer
   * transaction aborts.  This had better be within the critical section
   * too: it's not likely to fail, but if it did, we'd arrive at transaction
   * abort with the files still vulnerable.  PANICing will leave things in a
   * good state on-disk.
   *
   * Note: we're cheating a little bit here by assuming that mapped files
   * are either in pg_global or the database's default tablespace.
   */
  if (preserve_files)
  {
    int32   i;

    for (i = 0; i < newmap->num_mappings; i++)
    {
      RelFileLocator rlocator;

      rlocator.spcOid = tsid;
      rlocator.dbOid = dbid;
      rlocator.relNumber = newmap->mappings[i].mapfilenumber;
      RelationPreserveStorage(rlocator, false);
    }
  }

  /* Critical section done */
  if (write_wal)
    END_CRIT_SECTION();
}

/*
 * Merge the specified updates into the appropriate "real" map,
 * and write out the changes.  This function must be used for committing
 * updates during normal multiuser operation.
 */
static void
perform_relmap_update(bool shared, const RelMapFile *updates)
{
  RelMapFile  newmap;

  /*
   * Anyone updating a relation's mapping info should take exclusive lock on
   * that rel and hold it until commit.  This ensures that there will not be
   * concurrent updates on the same mapping value; but there could easily be
   * concurrent updates on different values in the same file. We cover that
   * by acquiring the RelationMappingLock, re-reading the target file to
   * ensure it's up to date, applying the updates, and writing the data
   * before releasing RelationMappingLock.
   *
   * There is only one RelationMappingLock.  In principle we could try to
   * have one per mapping file, but it seems unlikely to be worth the
   * trouble.
   */
  LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);

  /* Be certain we see any other updates just made */
  load_relmap_file(shared, true);

  /* Prepare updated data in a local variable */
  if (shared)
    memcpy(&newmap, &shared_map, sizeof(RelMapFile));
  else
    memcpy(&newmap, &local_map, sizeof(RelMapFile));

  /*
   * Apply the updates to newmap.  No new mappings should appear, unless
   * somebody is adding indexes to system catalogs.
   */
  merge_map_updates(&newmap, updates, allowSystemTableMods);

  /* Write out the updated map and do other necessary tasks */
  write_relmap_file(&newmap, true, true, true,
            (shared ? InvalidOid : MyDatabaseId),
            (shared ? GLOBALTABLESPACE_OID : MyDatabaseTableSpace),
            (shared ? "global" : DatabasePath));

  /*
   * We successfully wrote the updated file, so it's now safe to rely on the
   * new values in this process, too.
   */
  if (shared)
    memcpy(&shared_map, &newmap, sizeof(RelMapFile));
  else
    memcpy(&local_map, &newmap, sizeof(RelMapFile));

  /* Now we can release the lock */
  LWLockRelease(RelationMappingLock);
}

/*
 * RELMAP resource manager's routines
 */
void
relmap_redo(XLogReaderState *record)
{
  uint8   info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;

  /* Backup blocks are not used in relmap records */
  Assert(!XLogRecHasAnyBlockRefs(record));

  if (info == XLOG_RELMAP_UPDATE)
  {
    xl_relmap_update *xlrec = (xl_relmap_update *) XLogRecGetData(record);
    RelMapFile  newmap;
    char     *dbpath;

    if (xlrec->nbytes != sizeof(RelMapFile))
      elog(PANIC, "relmap_redo: wrong size %u in relmap update record",
         xlrec->nbytes);
    memcpy(&newmap, xlrec->data, sizeof(newmap));

    /* We need to construct the pathname for this database */
    dbpath = GetDatabasePath(xlrec->dbid, xlrec->tsid);

    /*
     * Write out the new map and send sinval, but of course don't write a
     * new WAL entry.  There's no surrounding transaction to tell to
     * preserve files, either.
     *
     * There shouldn't be anyone else updating relmaps during WAL replay,
     * but grab the lock to interlock against load_relmap_file().
     *
     * Note that we use the same WAL record for updating the relmap of an
     * existing database as we do for creating a new database. In the
     * latter case, taking the relmap log and sending sinval messages is
     * unnecessary, but harmless. If we wanted to avoid it, we could add a
     * flag to the WAL record to indicate which operation is being
     * performed.
     */
    LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);
    write_relmap_file(&newmap, false, true, false,
              xlrec->dbid, xlrec->tsid, dbpath);
    LWLockRelease(RelationMappingLock);

    pfree(dbpath);
  }
  else
    elog(PANIC, "relmap_redo: unknown op code %u", info);
}

Coverage Report

Created: 2026-08-13 07:12