sepgsql: update TAP test to use fat comma style
[pgsql.git] / src / backend / utils / cache / relmapper.c
blob1e72a2c7fd64ad0088adea0c86de2cafe7263f5b
1 /*-------------------------------------------------------------------------
3 * relmapper.c
4 * Catalog-to-filenumber mapping
6 * For most tables, the physical file underlying the table is specified by
7 * pg_class.relfilenode. However, that obviously won't work for pg_class
8 * itself, nor for the other "nailed" catalogs for which we have to be able
9 * to set up working Relation entries without access to pg_class. It also
10 * does not work for shared catalogs, since there is no practical way to
11 * update other databases' pg_class entries when relocating a shared catalog.
12 * Therefore, for these special catalogs (henceforth referred to as "mapped
13 * catalogs") we rely on a separately maintained file that shows the mapping
14 * from catalog OIDs to filenumbers. Each database has a map file for
15 * its local mapped catalogs, and there is a separate map file for shared
16 * catalogs. Mapped catalogs have zero in their pg_class.relfilenode entries.
18 * Relocation of a normal table is committed (ie, the new physical file becomes
19 * authoritative) when the pg_class row update commits. For mapped catalogs,
20 * the act of updating the map file is effectively commit of the relocation.
21 * We postpone the file update till just before commit of the transaction
22 * doing the rewrite, but there is necessarily a window between. Therefore
23 * mapped catalogs can only be relocated by operations such as VACUUM FULL
24 * and CLUSTER, which make no transactionally-significant changes: it must be
25 * safe for the new file to replace the old, even if the transaction itself
26 * aborts. An important factor here is that the indexes and toast table of
27 * a mapped catalog must also be mapped, so that the rewrites/relocations of
28 * all these files commit in a single map file update rather than being tied
29 * to transaction commit.
31 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
32 * Portions Copyright (c) 1994, Regents of the University of California
35 * IDENTIFICATION
36 * src/backend/utils/cache/relmapper.c
38 *-------------------------------------------------------------------------
40 #include "postgres.h"
42 #include <fcntl.h>
43 #include <sys/stat.h>
44 #include <unistd.h>
46 #include "access/xact.h"
47 #include "access/xlog.h"
48 #include "access/xloginsert.h"
49 #include "catalog/pg_tablespace.h"
50 #include "catalog/storage.h"
51 #include "miscadmin.h"
52 #include "pgstat.h"
53 #include "storage/fd.h"
54 #include "storage/lwlock.h"
55 #include "utils/inval.h"
56 #include "utils/relmapper.h"
60 * The map file is critical data: we have no automatic method for recovering
61 * from loss or corruption of it. We use a CRC so that we can detect
62 * corruption. Since the file might be more than one standard-size disk
63 * sector in size, we cannot rely on overwrite-in-place. Instead, we generate
64 * a new file and rename it into place, atomically replacing the original file.
66 * Entries in the mappings[] array are in no particular order. We could
67 * speed searching by insisting on OID order, but it really shouldn't be
68 * worth the trouble given the intended size of the mapping sets.
70 #define RELMAPPER_FILENAME "pg_filenode.map"
71 #define RELMAPPER_TEMP_FILENAME "pg_filenode.map.tmp"
73 #define RELMAPPER_FILEMAGIC 0x592717 /* version ID value */
76 * There's no need for this constant to have any particular value, and we
77 * can raise it as necessary if we end up with more mapped relations. For
78 * now, we just pick a round number that is modestly larger than the expected
79 * number of mappings.
81 #define MAX_MAPPINGS 64
83 typedef struct RelMapping
85 Oid mapoid; /* OID of a catalog */
86 RelFileNumber mapfilenumber; /* its rel file number */
87 } RelMapping;
89 typedef struct RelMapFile
91 int32 magic; /* always RELMAPPER_FILEMAGIC */
92 int32 num_mappings; /* number of valid RelMapping entries */
93 RelMapping mappings[MAX_MAPPINGS];
94 pg_crc32c crc; /* CRC of all above */
95 } RelMapFile;
98 * State for serializing local and shared relmappings for parallel workers
99 * (active states only). See notes on active_* and pending_* updates state.
101 typedef struct SerializedActiveRelMaps
103 RelMapFile active_shared_updates;
104 RelMapFile active_local_updates;
105 } SerializedActiveRelMaps;
108 * The currently known contents of the shared map file and our database's
109 * local map file are stored here. These can be reloaded from disk
110 * immediately whenever we receive an update sinval message.
112 static RelMapFile shared_map;
113 static RelMapFile local_map;
116 * We use the same RelMapFile data structure to track uncommitted local
117 * changes in the mappings (but note the magic and crc fields are not made
118 * valid in these variables). Currently, map updates are not allowed within
119 * subtransactions, so one set of transaction-level changes is sufficient.
121 * The active_xxx variables contain updates that are valid in our transaction
122 * and should be honored by RelationMapOidToFilenumber. The pending_xxx
123 * variables contain updates we have been told about that aren't active yet;
124 * they will become active at the next CommandCounterIncrement. This setup
125 * lets map updates act similarly to updates of pg_class rows, ie, they
126 * become visible only at the next CommandCounterIncrement boundary.
128 * Active shared and active local updates are serialized by the parallel
129 * infrastructure, and deserialized within parallel workers.
131 static RelMapFile active_shared_updates;
132 static RelMapFile active_local_updates;
133 static RelMapFile pending_shared_updates;
134 static RelMapFile pending_local_updates;
137 /* non-export function prototypes */
138 static void apply_map_update(RelMapFile *map, Oid relationId,
139 RelFileNumber fileNumber, bool add_okay);
140 static void merge_map_updates(RelMapFile *map, const RelMapFile *updates,
141 bool add_okay);
142 static void load_relmap_file(bool shared, bool lock_held);
143 static void read_relmap_file(RelMapFile *map, char *dbpath, bool lock_held,
144 int elevel);
145 static void write_relmap_file(RelMapFile *newmap, bool write_wal,
146 bool send_sinval, bool preserve_files,
147 Oid dbid, Oid tsid, const char *dbpath);
148 static void perform_relmap_update(bool shared, const RelMapFile *updates);
152 * RelationMapOidToFilenumber
154 * The raison d' etre ... given a relation OID, look up its filenumber.
156 * Although shared and local relation OIDs should never overlap, the caller
157 * always knows which we need --- so pass that information to avoid useless
158 * searching.
160 * Returns InvalidRelFileNumber if the OID is not known (which should never
161 * happen, but the caller is in a better position to report a meaningful
162 * error).
164 RelFileNumber
165 RelationMapOidToFilenumber(Oid relationId, bool shared)
167 const RelMapFile *map;
168 int32 i;
170 /* If there are active updates, believe those over the main maps */
171 if (shared)
173 map = &active_shared_updates;
174 for (i = 0; i < map->num_mappings; i++)
176 if (relationId == map->mappings[i].mapoid)
177 return map->mappings[i].mapfilenumber;
179 map = &shared_map;
180 for (i = 0; i < map->num_mappings; i++)
182 if (relationId == map->mappings[i].mapoid)
183 return map->mappings[i].mapfilenumber;
186 else
188 map = &active_local_updates;
189 for (i = 0; i < map->num_mappings; i++)
191 if (relationId == map->mappings[i].mapoid)
192 return map->mappings[i].mapfilenumber;
194 map = &local_map;
195 for (i = 0; i < map->num_mappings; i++)
197 if (relationId == map->mappings[i].mapoid)
198 return map->mappings[i].mapfilenumber;
202 return InvalidRelFileNumber;
206 * RelationMapFilenumberToOid
208 * Do the reverse of the normal direction of mapping done in
209 * RelationMapOidToFilenumber.
211 * This is not supposed to be used during normal running but rather for
212 * information purposes when looking at the filesystem or xlog.
214 * Returns InvalidOid if the OID is not known; this can easily happen if the
215 * relfilenumber doesn't pertain to a mapped relation.
218 RelationMapFilenumberToOid(RelFileNumber filenumber, bool shared)
220 const RelMapFile *map;
221 int32 i;
223 /* If there are active updates, believe those over the main maps */
224 if (shared)
226 map = &active_shared_updates;
227 for (i = 0; i < map->num_mappings; i++)
229 if (filenumber == map->mappings[i].mapfilenumber)
230 return map->mappings[i].mapoid;
232 map = &shared_map;
233 for (i = 0; i < map->num_mappings; i++)
235 if (filenumber == map->mappings[i].mapfilenumber)
236 return map->mappings[i].mapoid;
239 else
241 map = &active_local_updates;
242 for (i = 0; i < map->num_mappings; i++)
244 if (filenumber == map->mappings[i].mapfilenumber)
245 return map->mappings[i].mapoid;
247 map = &local_map;
248 for (i = 0; i < map->num_mappings; i++)
250 if (filenumber == map->mappings[i].mapfilenumber)
251 return map->mappings[i].mapoid;
255 return InvalidOid;
259 * RelationMapOidToFilenumberForDatabase
261 * Like RelationMapOidToFilenumber, but reads the mapping from the indicated
262 * path instead of using the one for the current database.
264 RelFileNumber
265 RelationMapOidToFilenumberForDatabase(char *dbpath, Oid relationId)
267 RelMapFile map;
268 int i;
270 /* Read the relmap file from the source database. */
271 read_relmap_file(&map, dbpath, false, ERROR);
273 /* Iterate over the relmap entries to find the input relation OID. */
274 for (i = 0; i < map.num_mappings; i++)
276 if (relationId == map.mappings[i].mapoid)
277 return map.mappings[i].mapfilenumber;
280 return InvalidRelFileNumber;
284 * RelationMapCopy
286 * Copy relmapfile from source db path to the destination db path and WAL log
287 * the operation. This is intended for use in creating a new relmap file
288 * for a database that doesn't have one yet, not for replacing an existing
289 * relmap file.
291 void
292 RelationMapCopy(Oid dbid, Oid tsid, char *srcdbpath, char *dstdbpath)
294 RelMapFile map;
297 * Read the relmap file from the source database.
299 read_relmap_file(&map, srcdbpath, false, ERROR);
302 * Write the same data into the destination database's relmap file.
304 * No sinval is needed because no one can be connected to the destination
305 * database yet.
307 * There's no point in trying to preserve files here. The new database
308 * isn't usable yet anyway, and won't ever be if we can't install a relmap
309 * file.
311 LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);
312 write_relmap_file(&map, true, false, false, dbid, tsid, dstdbpath);
313 LWLockRelease(RelationMappingLock);
317 * RelationMapUpdateMap
319 * Install a new relfilenumber mapping for the specified relation.
321 * If immediate is true (or we're bootstrapping), the mapping is activated
322 * immediately. Otherwise it is made pending until CommandCounterIncrement.
324 void
325 RelationMapUpdateMap(Oid relationId, RelFileNumber fileNumber, bool shared,
326 bool immediate)
328 RelMapFile *map;
330 if (IsBootstrapProcessingMode())
333 * In bootstrap mode, the mapping gets installed in permanent map.
335 if (shared)
336 map = &shared_map;
337 else
338 map = &local_map;
340 else
343 * We don't currently support map changes within subtransactions, or
344 * when in parallel mode. This could be done with more bookkeeping
345 * infrastructure, but it doesn't presently seem worth it.
347 if (GetCurrentTransactionNestLevel() > 1)
348 elog(ERROR, "cannot change relation mapping within subtransaction");
350 if (IsInParallelMode())
351 elog(ERROR, "cannot change relation mapping in parallel mode");
353 if (immediate)
355 /* Make it active, but only locally */
356 if (shared)
357 map = &active_shared_updates;
358 else
359 map = &active_local_updates;
361 else
363 /* Make it pending */
364 if (shared)
365 map = &pending_shared_updates;
366 else
367 map = &pending_local_updates;
370 apply_map_update(map, relationId, fileNumber, true);
374 * apply_map_update
376 * Insert a new mapping into the given map variable, replacing any existing
377 * mapping for the same relation.
379 * In some cases the caller knows there must be an existing mapping; pass
380 * add_okay = false to draw an error if not.
382 static void
383 apply_map_update(RelMapFile *map, Oid relationId, RelFileNumber fileNumber,
384 bool add_okay)
386 int32 i;
388 /* Replace any existing mapping */
389 for (i = 0; i < map->num_mappings; i++)
391 if (relationId == map->mappings[i].mapoid)
393 map->mappings[i].mapfilenumber = fileNumber;
394 return;
398 /* Nope, need to add a new mapping */
399 if (!add_okay)
400 elog(ERROR, "attempt to apply a mapping to unmapped relation %u",
401 relationId);
402 if (map->num_mappings >= MAX_MAPPINGS)
403 elog(ERROR, "ran out of space in relation map");
404 map->mappings[map->num_mappings].mapoid = relationId;
405 map->mappings[map->num_mappings].mapfilenumber = fileNumber;
406 map->num_mappings++;
410 * merge_map_updates
412 * Merge all the updates in the given pending-update map into the target map.
413 * This is just a bulk form of apply_map_update.
415 static void
416 merge_map_updates(RelMapFile *map, const RelMapFile *updates, bool add_okay)
418 int32 i;
420 for (i = 0; i < updates->num_mappings; i++)
422 apply_map_update(map,
423 updates->mappings[i].mapoid,
424 updates->mappings[i].mapfilenumber,
425 add_okay);
430 * RelationMapRemoveMapping
432 * Remove a relation's entry in the map. This is only allowed for "active"
433 * (but not committed) local mappings. We need it so we can back out the
434 * entry for the transient target file when doing VACUUM FULL/CLUSTER on
435 * a mapped relation.
437 void
438 RelationMapRemoveMapping(Oid relationId)
440 RelMapFile *map = &active_local_updates;
441 int32 i;
443 for (i = 0; i < map->num_mappings; i++)
445 if (relationId == map->mappings[i].mapoid)
447 /* Found it, collapse it out */
448 map->mappings[i] = map->mappings[map->num_mappings - 1];
449 map->num_mappings--;
450 return;
453 elog(ERROR, "could not find temporary mapping for relation %u",
454 relationId);
458 * RelationMapInvalidate
460 * This routine is invoked for SI cache flush messages. We must re-read
461 * the indicated map file. However, we might receive a SI message in a
462 * process that hasn't yet, and might never, load the mapping files;
463 * for example the autovacuum launcher, which *must not* try to read
464 * a local map since it is attached to no particular database.
465 * So, re-read only if the map is valid now.
467 void
468 RelationMapInvalidate(bool shared)
470 if (shared)
472 if (shared_map.magic == RELMAPPER_FILEMAGIC)
473 load_relmap_file(true, false);
475 else
477 if (local_map.magic == RELMAPPER_FILEMAGIC)
478 load_relmap_file(false, false);
483 * RelationMapInvalidateAll
485 * Reload all map files. This is used to recover from SI message buffer
486 * overflow: we can't be sure if we missed an inval message.
487 * Again, reload only currently-valid maps.
489 void
490 RelationMapInvalidateAll(void)
492 if (shared_map.magic == RELMAPPER_FILEMAGIC)
493 load_relmap_file(true, false);
494 if (local_map.magic == RELMAPPER_FILEMAGIC)
495 load_relmap_file(false, false);
499 * AtCCI_RelationMap
501 * Activate any "pending" relation map updates at CommandCounterIncrement time.
503 void
504 AtCCI_RelationMap(void)
506 if (pending_shared_updates.num_mappings != 0)
508 merge_map_updates(&active_shared_updates,
509 &pending_shared_updates,
510 true);
511 pending_shared_updates.num_mappings = 0;
513 if (pending_local_updates.num_mappings != 0)
515 merge_map_updates(&active_local_updates,
516 &pending_local_updates,
517 true);
518 pending_local_updates.num_mappings = 0;
523 * AtEOXact_RelationMap
525 * Handle relation mapping at main-transaction commit or abort.
527 * During commit, this must be called as late as possible before the actual
528 * transaction commit, so as to minimize the window where the transaction
529 * could still roll back after committing map changes. Although nothing
530 * critically bad happens in such a case, we still would prefer that it
531 * not happen, since we'd possibly be losing useful updates to the relations'
532 * pg_class row(s).
534 * During abort, we just have to throw away any pending map changes.
535 * Normal post-abort cleanup will take care of fixing relcache entries.
536 * Parallel worker commit/abort is handled by resetting active mappings
537 * that may have been received from the leader process. (There should be
538 * no pending updates in parallel workers.)
540 void
541 AtEOXact_RelationMap(bool isCommit, bool isParallelWorker)
543 if (isCommit && !isParallelWorker)
546 * We should not get here with any "pending" updates. (We could
547 * logically choose to treat such as committed, but in the current
548 * code this should never happen.)
550 Assert(pending_shared_updates.num_mappings == 0);
551 Assert(pending_local_updates.num_mappings == 0);
554 * Write any active updates to the actual map files, then reset them.
556 if (active_shared_updates.num_mappings != 0)
558 perform_relmap_update(true, &active_shared_updates);
559 active_shared_updates.num_mappings = 0;
561 if (active_local_updates.num_mappings != 0)
563 perform_relmap_update(false, &active_local_updates);
564 active_local_updates.num_mappings = 0;
567 else
569 /* Abort or parallel worker --- drop all local and pending updates */
570 Assert(!isParallelWorker || pending_shared_updates.num_mappings == 0);
571 Assert(!isParallelWorker || pending_local_updates.num_mappings == 0);
573 active_shared_updates.num_mappings = 0;
574 active_local_updates.num_mappings = 0;
575 pending_shared_updates.num_mappings = 0;
576 pending_local_updates.num_mappings = 0;
581 * AtPrepare_RelationMap
583 * Handle relation mapping at PREPARE.
585 * Currently, we don't support preparing any transaction that changes the map.
587 void
588 AtPrepare_RelationMap(void)
590 if (active_shared_updates.num_mappings != 0 ||
591 active_local_updates.num_mappings != 0 ||
592 pending_shared_updates.num_mappings != 0 ||
593 pending_local_updates.num_mappings != 0)
594 ereport(ERROR,
595 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
596 errmsg("cannot PREPARE a transaction that modified relation mapping")));
600 * CheckPointRelationMap
602 * This is called during a checkpoint. It must ensure that any relation map
603 * updates that were WAL-logged before the start of the checkpoint are
604 * securely flushed to disk and will not need to be replayed later. This
605 * seems unlikely to be a performance-critical issue, so we use a simple
606 * method: we just take and release the RelationMappingLock. This ensures
607 * that any already-logged map update is complete, because write_relmap_file
608 * will fsync the map file before the lock is released.
610 void
611 CheckPointRelationMap(void)
613 LWLockAcquire(RelationMappingLock, LW_SHARED);
614 LWLockRelease(RelationMappingLock);
618 * RelationMapFinishBootstrap
620 * Write out the initial relation mapping files at the completion of
621 * bootstrap. All the mapped files should have been made known to us
622 * via RelationMapUpdateMap calls.
624 void
625 RelationMapFinishBootstrap(void)
627 Assert(IsBootstrapProcessingMode());
629 /* Shouldn't be anything "pending" ... */
630 Assert(active_shared_updates.num_mappings == 0);
631 Assert(active_local_updates.num_mappings == 0);
632 Assert(pending_shared_updates.num_mappings == 0);
633 Assert(pending_local_updates.num_mappings == 0);
635 /* Write the files; no WAL or sinval needed */
636 LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);
637 write_relmap_file(&shared_map, false, false, false,
638 InvalidOid, GLOBALTABLESPACE_OID, "global");
639 write_relmap_file(&local_map, false, false, false,
640 MyDatabaseId, MyDatabaseTableSpace, DatabasePath);
641 LWLockRelease(RelationMappingLock);
645 * RelationMapInitialize
647 * This initializes the mapper module at process startup. We can't access the
648 * database yet, so just make sure the maps are empty.
650 void
651 RelationMapInitialize(void)
653 /* The static variables should initialize to zeroes, but let's be sure */
654 shared_map.magic = 0; /* mark it not loaded */
655 local_map.magic = 0;
656 shared_map.num_mappings = 0;
657 local_map.num_mappings = 0;
658 active_shared_updates.num_mappings = 0;
659 active_local_updates.num_mappings = 0;
660 pending_shared_updates.num_mappings = 0;
661 pending_local_updates.num_mappings = 0;
665 * RelationMapInitializePhase2
667 * This is called to prepare for access to pg_database during startup.
668 * We should be able to read the shared map file now.
670 void
671 RelationMapInitializePhase2(void)
674 * In bootstrap mode, the map file isn't there yet, so do nothing.
676 if (IsBootstrapProcessingMode())
677 return;
680 * Load the shared map file, die on error.
682 load_relmap_file(true, false);
686 * RelationMapInitializePhase3
688 * This is called as soon as we have determined MyDatabaseId and set up
689 * DatabasePath. At this point we should be able to read the local map file.
691 void
692 RelationMapInitializePhase3(void)
695 * In bootstrap mode, the map file isn't there yet, so do nothing.
697 if (IsBootstrapProcessingMode())
698 return;
701 * Load the local map file, die on error.
703 load_relmap_file(false, false);
707 * EstimateRelationMapSpace
709 * Estimate space needed to pass active shared and local relmaps to parallel
710 * workers.
712 Size
713 EstimateRelationMapSpace(void)
715 return sizeof(SerializedActiveRelMaps);
719 * SerializeRelationMap
721 * Serialize active shared and local relmap state for parallel workers.
723 void
724 SerializeRelationMap(Size maxSize, char *startAddress)
726 SerializedActiveRelMaps *relmaps;
728 Assert(maxSize >= EstimateRelationMapSpace());
730 relmaps = (SerializedActiveRelMaps *) startAddress;
731 relmaps->active_shared_updates = active_shared_updates;
732 relmaps->active_local_updates = active_local_updates;
736 * RestoreRelationMap
738 * Restore active shared and local relmap state within a parallel worker.
740 void
741 RestoreRelationMap(char *startAddress)
743 SerializedActiveRelMaps *relmaps;
745 if (active_shared_updates.num_mappings != 0 ||
746 active_local_updates.num_mappings != 0 ||
747 pending_shared_updates.num_mappings != 0 ||
748 pending_local_updates.num_mappings != 0)
749 elog(ERROR, "parallel worker has existing mappings");
751 relmaps = (SerializedActiveRelMaps *) startAddress;
752 active_shared_updates = relmaps->active_shared_updates;
753 active_local_updates = relmaps->active_local_updates;
757 * load_relmap_file -- load the shared or local map file
759 * Because these files are essential for access to core system catalogs,
760 * failure to load either of them is a fatal error.
762 * Note that the local case requires DatabasePath to be set up.
764 static void
765 load_relmap_file(bool shared, bool lock_held)
767 if (shared)
768 read_relmap_file(&shared_map, "global", lock_held, FATAL);
769 else
770 read_relmap_file(&local_map, DatabasePath, lock_held, FATAL);
774 * read_relmap_file -- load data from any relation mapper file
776 * dbpath must be the relevant database path, or "global" for shared relations.
778 * RelationMappingLock will be acquired released unless lock_held = true.
780 * Errors will be reported at the indicated elevel, which should be at least
781 * ERROR.
783 static void
784 read_relmap_file(RelMapFile *map, char *dbpath, bool lock_held, int elevel)
786 char mapfilename[MAXPGPATH];
787 pg_crc32c crc;
788 int fd;
789 int r;
791 Assert(elevel >= ERROR);
794 * Grab the lock to prevent the file from being updated while we read it,
795 * unless the caller is already holding the lock. If the file is updated
796 * shortly after we look, the sinval signaling mechanism will make us
797 * re-read it before we are able to access any relation that's affected by
798 * the change.
800 if (!lock_held)
801 LWLockAcquire(RelationMappingLock, LW_SHARED);
804 * Open the target file.
806 * Because Windows isn't happy about the idea of renaming over a file that
807 * someone has open, we only open this file after acquiring the lock, and
808 * for the same reason, we close it before releasing the lock. That way,
809 * by the time write_relmap_file() acquires an exclusive lock, no one else
810 * will have it open.
812 snprintf(mapfilename, sizeof(mapfilename), "%s/%s", dbpath,
813 RELMAPPER_FILENAME);
814 fd = OpenTransientFile(mapfilename, O_RDONLY | PG_BINARY);
815 if (fd < 0)
816 ereport(elevel,
817 (errcode_for_file_access(),
818 errmsg("could not open file \"%s\": %m",
819 mapfilename)));
821 /* Now read the data. */
822 pgstat_report_wait_start(WAIT_EVENT_RELATION_MAP_READ);
823 r = read(fd, map, sizeof(RelMapFile));
824 if (r != sizeof(RelMapFile))
826 if (r < 0)
827 ereport(elevel,
828 (errcode_for_file_access(),
829 errmsg("could not read file \"%s\": %m", mapfilename)));
830 else
831 ereport(elevel,
832 (errcode(ERRCODE_DATA_CORRUPTED),
833 errmsg("could not read file \"%s\": read %d of %zu",
834 mapfilename, r, sizeof(RelMapFile))));
836 pgstat_report_wait_end();
838 if (CloseTransientFile(fd) != 0)
839 ereport(elevel,
840 (errcode_for_file_access(),
841 errmsg("could not close file \"%s\": %m",
842 mapfilename)));
844 if (!lock_held)
845 LWLockRelease(RelationMappingLock);
847 /* check for correct magic number, etc */
848 if (map->magic != RELMAPPER_FILEMAGIC ||
849 map->num_mappings < 0 ||
850 map->num_mappings > MAX_MAPPINGS)
851 ereport(elevel,
852 (errmsg("relation mapping file \"%s\" contains invalid data",
853 mapfilename)));
855 /* verify the CRC */
856 INIT_CRC32C(crc);
857 COMP_CRC32C(crc, (char *) map, offsetof(RelMapFile, crc));
858 FIN_CRC32C(crc);
860 if (!EQ_CRC32C(crc, map->crc))
861 ereport(elevel,
862 (errmsg("relation mapping file \"%s\" contains incorrect checksum",
863 mapfilename)));
867 * Write out a new shared or local map file with the given contents.
869 * The magic number and CRC are automatically updated in *newmap. On
870 * success, we copy the data to the appropriate permanent static variable.
872 * If write_wal is true then an appropriate WAL message is emitted.
873 * (It will be false for bootstrap and WAL replay cases.)
875 * If send_sinval is true then a SI invalidation message is sent.
876 * (This should be true except in bootstrap case.)
878 * If preserve_files is true then the storage manager is warned not to
879 * delete the files listed in the map.
881 * Because this may be called during WAL replay when MyDatabaseId,
882 * DatabasePath, etc aren't valid, we require the caller to pass in suitable
883 * values. Pass dbpath as "global" for the shared map.
885 * The caller is also responsible for being sure no concurrent map update
886 * could be happening.
888 static void
889 write_relmap_file(RelMapFile *newmap, bool write_wal, bool send_sinval,
890 bool preserve_files, Oid dbid, Oid tsid, const char *dbpath)
892 int fd;
893 char mapfilename[MAXPGPATH];
894 char maptempfilename[MAXPGPATH];
897 * Even without concurrent use of this map, CheckPointRelationMap() relies
898 * on this locking. Without it, a restore of a base backup taken after
899 * this function's XLogInsert() and before its durable_rename() would not
900 * have the changes. wal_level=minimal doesn't need the lock, but this
901 * isn't performance-critical enough for such a micro-optimization.
903 Assert(LWLockHeldByMeInMode(RelationMappingLock, LW_EXCLUSIVE));
906 * Fill in the overhead fields and update CRC.
908 newmap->magic = RELMAPPER_FILEMAGIC;
909 if (newmap->num_mappings < 0 || newmap->num_mappings > MAX_MAPPINGS)
910 elog(ERROR, "attempt to write bogus relation mapping");
912 INIT_CRC32C(newmap->crc);
913 COMP_CRC32C(newmap->crc, (char *) newmap, offsetof(RelMapFile, crc));
914 FIN_CRC32C(newmap->crc);
917 * Construct filenames -- a temporary file that we'll create to write the
918 * data initially, and then the permanent name to which we will rename it.
920 snprintf(mapfilename, sizeof(mapfilename), "%s/%s",
921 dbpath, RELMAPPER_FILENAME);
922 snprintf(maptempfilename, sizeof(maptempfilename), "%s/%s",
923 dbpath, RELMAPPER_TEMP_FILENAME);
926 * Open a temporary file. If a file already exists with this name, it must
927 * be left over from a previous crash, so we can overwrite it. Concurrent
928 * calls to this function are not allowed.
930 fd = OpenTransientFile(maptempfilename,
931 O_WRONLY | O_CREAT | O_TRUNC | PG_BINARY);
932 if (fd < 0)
933 ereport(ERROR,
934 (errcode_for_file_access(),
935 errmsg("could not open file \"%s\": %m",
936 maptempfilename)));
938 /* Write new data to the file. */
939 pgstat_report_wait_start(WAIT_EVENT_RELATION_MAP_WRITE);
940 if (write(fd, newmap, sizeof(RelMapFile)) != sizeof(RelMapFile))
942 /* if write didn't set errno, assume problem is no disk space */
943 if (errno == 0)
944 errno = ENOSPC;
945 ereport(ERROR,
946 (errcode_for_file_access(),
947 errmsg("could not write file \"%s\": %m",
948 maptempfilename)));
950 pgstat_report_wait_end();
952 /* And close the file. */
953 if (CloseTransientFile(fd) != 0)
954 ereport(ERROR,
955 (errcode_for_file_access(),
956 errmsg("could not close file \"%s\": %m",
957 maptempfilename)));
959 if (write_wal)
961 xl_relmap_update xlrec;
962 XLogRecPtr lsn;
964 /* now errors are fatal ... */
965 START_CRIT_SECTION();
967 xlrec.dbid = dbid;
968 xlrec.tsid = tsid;
969 xlrec.nbytes = sizeof(RelMapFile);
971 XLogBeginInsert();
972 XLogRegisterData((char *) (&xlrec), MinSizeOfRelmapUpdate);
973 XLogRegisterData((char *) newmap, sizeof(RelMapFile));
975 lsn = XLogInsert(RM_RELMAP_ID, XLOG_RELMAP_UPDATE);
977 /* As always, WAL must hit the disk before the data update does */
978 XLogFlush(lsn);
982 * durable_rename() does all the hard work of making sure that we rename
983 * the temporary file into place in a crash-safe manner.
985 * NB: Although we instruct durable_rename() to use ERROR, we will often
986 * be in a critical section at this point; if so, ERROR will become PANIC.
988 pgstat_report_wait_start(WAIT_EVENT_RELATION_MAP_REPLACE);
989 durable_rename(maptempfilename, mapfilename, ERROR);
990 pgstat_report_wait_end();
993 * Now that the file is safely on disk, send sinval message to let other
994 * backends know to re-read it. We must do this inside the critical
995 * section: if for some reason we fail to send the message, we have to
996 * force a database-wide PANIC. Otherwise other backends might continue
997 * execution with stale mapping information, which would be catastrophic
998 * as soon as others began to use the now-committed data.
1000 if (send_sinval)
1001 CacheInvalidateRelmap(dbid);
1004 * Make sure that the files listed in the map are not deleted if the outer
1005 * transaction aborts. This had better be within the critical section
1006 * too: it's not likely to fail, but if it did, we'd arrive at transaction
1007 * abort with the files still vulnerable. PANICing will leave things in a
1008 * good state on-disk.
1010 * Note: we're cheating a little bit here by assuming that mapped files
1011 * are either in pg_global or the database's default tablespace.
1013 if (preserve_files)
1015 int32 i;
1017 for (i = 0; i < newmap->num_mappings; i++)
1019 RelFileLocator rlocator;
1021 rlocator.spcOid = tsid;
1022 rlocator.dbOid = dbid;
1023 rlocator.relNumber = newmap->mappings[i].mapfilenumber;
1024 RelationPreserveStorage(rlocator, false);
1028 /* Critical section done */
1029 if (write_wal)
1030 END_CRIT_SECTION();
1034 * Merge the specified updates into the appropriate "real" map,
1035 * and write out the changes. This function must be used for committing
1036 * updates during normal multiuser operation.
1038 static void
1039 perform_relmap_update(bool shared, const RelMapFile *updates)
1041 RelMapFile newmap;
1044 * Anyone updating a relation's mapping info should take exclusive lock on
1045 * that rel and hold it until commit. This ensures that there will not be
1046 * concurrent updates on the same mapping value; but there could easily be
1047 * concurrent updates on different values in the same file. We cover that
1048 * by acquiring the RelationMappingLock, re-reading the target file to
1049 * ensure it's up to date, applying the updates, and writing the data
1050 * before releasing RelationMappingLock.
1052 * There is only one RelationMappingLock. In principle we could try to
1053 * have one per mapping file, but it seems unlikely to be worth the
1054 * trouble.
1056 LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);
1058 /* Be certain we see any other updates just made */
1059 load_relmap_file(shared, true);
1061 /* Prepare updated data in a local variable */
1062 if (shared)
1063 memcpy(&newmap, &shared_map, sizeof(RelMapFile));
1064 else
1065 memcpy(&newmap, &local_map, sizeof(RelMapFile));
1068 * Apply the updates to newmap. No new mappings should appear, unless
1069 * somebody is adding indexes to system catalogs.
1071 merge_map_updates(&newmap, updates, allowSystemTableMods);
1073 /* Write out the updated map and do other necessary tasks */
1074 write_relmap_file(&newmap, true, true, true,
1075 (shared ? InvalidOid : MyDatabaseId),
1076 (shared ? GLOBALTABLESPACE_OID : MyDatabaseTableSpace),
1077 (shared ? "global" : DatabasePath));
1080 * We successfully wrote the updated file, so it's now safe to rely on the
1081 * new values in this process, too.
1083 if (shared)
1084 memcpy(&shared_map, &newmap, sizeof(RelMapFile));
1085 else
1086 memcpy(&local_map, &newmap, sizeof(RelMapFile));
1088 /* Now we can release the lock */
1089 LWLockRelease(RelationMappingLock);
1093 * RELMAP resource manager's routines
1095 void
1096 relmap_redo(XLogReaderState *record)
1098 uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
1100 /* Backup blocks are not used in relmap records */
1101 Assert(!XLogRecHasAnyBlockRefs(record));
1103 if (info == XLOG_RELMAP_UPDATE)
1105 xl_relmap_update *xlrec = (xl_relmap_update *) XLogRecGetData(record);
1106 RelMapFile newmap;
1107 char *dbpath;
1109 if (xlrec->nbytes != sizeof(RelMapFile))
1110 elog(PANIC, "relmap_redo: wrong size %u in relmap update record",
1111 xlrec->nbytes);
1112 memcpy(&newmap, xlrec->data, sizeof(newmap));
1114 /* We need to construct the pathname for this database */
1115 dbpath = GetDatabasePath(xlrec->dbid, xlrec->tsid);
1118 * Write out the new map and send sinval, but of course don't write a
1119 * new WAL entry. There's no surrounding transaction to tell to
1120 * preserve files, either.
1122 * There shouldn't be anyone else updating relmaps during WAL replay,
1123 * but grab the lock to interlock against load_relmap_file().
1125 * Note that we use the same WAL record for updating the relmap of an
1126 * existing database as we do for creating a new database. In the
1127 * latter case, taking the relmap log and sending sinval messages is
1128 * unnecessary, but harmless. If we wanted to avoid it, we could add a
1129 * flag to the WAL record to indicate which operation is being
1130 * performed.
1132 LWLockAcquire(RelationMappingLock, LW_EXCLUSIVE);
1133 write_relmap_file(&newmap, false, true, false,
1134 xlrec->dbid, xlrec->tsid, dbpath);
1135 LWLockRelease(RelationMappingLock);
1137 pfree(dbpath);
1139 else
1140 elog(PANIC, "relmap_redo: unknown op code %u", info);