LCOV - code coverage report
Current view: top level - src/backend/storage/smgr - smgr.c (source / functions) Coverage Total Hit
Test: Code coverage Lines: 85.2 % 318 271
Test Date: 2026-01-26 10:56:24 Functions: 88.2 % 34 30
Legend: Lines:     hit not hit
Branches: + taken - not taken # not executed
Branches: 54.3 % 162 88

             Branch data     Line data    Source code
       1                 :             : /*-------------------------------------------------------------------------
       2                 :             :  *
       3                 :             :  * smgr.c
       4                 :             :  *        public interface routines to storage manager switch.
       5                 :             :  *
       6                 :             :  * All file system operations on relations dispatch through these routines.
       7                 :             :  * An SMgrRelation represents physical on-disk relation files that are open
       8                 :             :  * for reading and writing.
       9                 :             :  *
      10                 :             :  * When a relation is first accessed through the relation cache, the
      11                 :             :  * corresponding SMgrRelation entry is opened by calling smgropen(), and the
      12                 :             :  * reference is stored in the relation cache entry.
      13                 :             :  *
      14                 :             :  * Accesses that don't go through the relation cache open the SMgrRelation
      15                 :             :  * directly.  That includes flushing buffers from the buffer cache, as well as
      16                 :             :  * all accesses in auxiliary processes like the checkpointer or the WAL redo
      17                 :             :  * in the startup process.
      18                 :             :  *
      19                 :             :  * Operations like CREATE, DROP, ALTER TABLE also hold SMgrRelation references
      20                 :             :  * independent of the relation cache.  They need to prepare the physical files
      21                 :             :  * before updating the relation cache.
      22                 :             :  *
      23                 :             :  * There is a hash table that holds all the SMgrRelation entries in the
      24                 :             :  * backend.  If you call smgropen() twice for the same rel locator, you get a
      25                 :             :  * reference to the same SMgrRelation. The reference is valid until the end of
      26                 :             :  * transaction.  This makes repeated access to the same relation efficient,
      27                 :             :  * and allows caching things like the relation size in the SMgrRelation entry.
      28                 :             :  *
      29                 :             :  * At end of transaction, all SMgrRelation entries that haven't been pinned
      30                 :             :  * are removed.  An SMgrRelation can hold kernel file system descriptors for
      31                 :             :  * the underlying files, and we'd like to close those reasonably soon if the
      32                 :             :  * file gets deleted.  The SMgrRelations references held by the relcache are
      33                 :             :  * pinned to prevent them from being closed.
      34                 :             :  *
      35                 :             :  * There is another mechanism to close file descriptors early:
      36                 :             :  * PROCSIGNAL_BARRIER_SMGRRELEASE.  It is a request to immediately close all
      37                 :             :  * file descriptors.  Upon receiving that signal, the backend closes all file
      38                 :             :  * descriptors held open by SMgrRelations, but because it can happen in the
      39                 :             :  * middle of a transaction, we cannot destroy the SMgrRelation objects
      40                 :             :  * themselves, as there could pointers to them in active use.  See
      41                 :             :  * smgrrelease() and smgrreleaseall().
      42                 :             :  *
      43                 :             :  * NB: We need to hold interrupts across most of the functions in this file,
      44                 :             :  * as otherwise interrupt processing, e.g. due to a < ERROR elog/ereport, can
      45                 :             :  * trigger procsignal processing, which in turn can trigger
      46                 :             :  * smgrreleaseall(). Most of the relevant code is not reentrant.  It seems
      47                 :             :  * better to put the HOLD_INTERRUPTS()/RESUME_INTERRUPTS() here, instead of
      48                 :             :  * trying to push them down to md.c where possible: For one, every smgr
      49                 :             :  * implementation would be vulnerable, for another, a good bit of smgr.c code
      50                 :             :  * itself is affected too.  Eventually we might want a more targeted solution,
      51                 :             :  * allowing e.g. a networked smgr implementation to be interrupted, but many
      52                 :             :  * other, more complicated, problems would need to be fixed for that to be
      53                 :             :  * viable (e.g. smgr.c is often called with interrupts already held).
      54                 :             :  *
      55                 :             :  * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
      56                 :             :  * Portions Copyright (c) 1994, Regents of the University of California
      57                 :             :  *
      58                 :             :  *
      59                 :             :  * IDENTIFICATION
      60                 :             :  *        src/backend/storage/smgr/smgr.c
      61                 :             :  *
      62                 :             :  *-------------------------------------------------------------------------
      63                 :             :  */
      64                 :             : #include "postgres.h"
      65                 :             : 
      66                 :             : #include "access/xlogutils.h"
      67                 :             : #include "lib/ilist.h"
      68                 :             : #include "miscadmin.h"
      69                 :             : #include "storage/aio.h"
      70                 :             : #include "storage/bufmgr.h"
      71                 :             : #include "storage/ipc.h"
      72                 :             : #include "storage/md.h"
      73                 :             : #include "storage/smgr.h"
      74                 :             : #include "utils/hsearch.h"
      75                 :             : #include "utils/inval.h"
      76                 :             : 
      77                 :             : 
      78                 :             : /*
      79                 :             :  * This struct of function pointers defines the API between smgr.c and
      80                 :             :  * any individual storage manager module.  Note that smgr subfunctions are
      81                 :             :  * generally expected to report problems via elog(ERROR).  An exception is
      82                 :             :  * that smgr_unlink should use elog(WARNING), rather than erroring out,
      83                 :             :  * because we normally unlink relations during post-commit/abort cleanup,
      84                 :             :  * and so it's too late to raise an error.  Also, various conditions that
      85                 :             :  * would normally be errors should be allowed during bootstrap and/or WAL
      86                 :             :  * recovery --- see comments in md.c for details.
      87                 :             :  */
      88                 :             : typedef struct f_smgr
      89                 :             : {
      90                 :             :         void            (*smgr_init) (void);    /* may be NULL */
      91                 :             :         void            (*smgr_shutdown) (void);        /* may be NULL */
      92                 :             :         void            (*smgr_open) (SMgrRelation reln);
      93                 :             :         void            (*smgr_close) (SMgrRelation reln, ForkNumber forknum);
      94                 :             :         void            (*smgr_create) (SMgrRelation reln, ForkNumber forknum,
      95                 :             :                                                                 bool isRedo);
      96                 :             :         bool            (*smgr_exists) (SMgrRelation reln, ForkNumber forknum);
      97                 :             :         void            (*smgr_unlink) (RelFileLocatorBackend rlocator, ForkNumber forknum,
      98                 :             :                                                                 bool isRedo);
      99                 :             :         void            (*smgr_extend) (SMgrRelation reln, ForkNumber forknum,
     100                 :             :                                                                 BlockNumber blocknum, const void *buffer, bool skipFsync);
     101                 :             :         void            (*smgr_zeroextend) (SMgrRelation reln, ForkNumber forknum,
     102                 :             :                                                                         BlockNumber blocknum, int nblocks, bool skipFsync);
     103                 :             :         bool            (*smgr_prefetch) (SMgrRelation reln, ForkNumber forknum,
     104                 :             :                                                                   BlockNumber blocknum, int nblocks);
     105                 :             :         uint32          (*smgr_maxcombine) (SMgrRelation reln, ForkNumber forknum,
     106                 :             :                                                                         BlockNumber blocknum);
     107                 :             :         void            (*smgr_readv) (SMgrRelation reln, ForkNumber forknum,
     108                 :             :                                                            BlockNumber blocknum,
     109                 :             :                                                            void **buffers, BlockNumber nblocks);
     110                 :             :         void            (*smgr_startreadv) (PgAioHandle *ioh,
     111                 :             :                                                                         SMgrRelation reln, ForkNumber forknum,
     112                 :             :                                                                         BlockNumber blocknum,
     113                 :             :                                                                         void **buffers, BlockNumber nblocks);
     114                 :             :         void            (*smgr_writev) (SMgrRelation reln, ForkNumber forknum,
     115                 :             :                                                                 BlockNumber blocknum,
     116                 :             :                                                                 const void **buffers, BlockNumber nblocks,
     117                 :             :                                                                 bool skipFsync);
     118                 :             :         void            (*smgr_writeback) (SMgrRelation reln, ForkNumber forknum,
     119                 :             :                                                                    BlockNumber blocknum, BlockNumber nblocks);
     120                 :             :         BlockNumber (*smgr_nblocks) (SMgrRelation reln, ForkNumber forknum);
     121                 :             :         void            (*smgr_truncate) (SMgrRelation reln, ForkNumber forknum,
     122                 :             :                                                                   BlockNumber old_blocks, BlockNumber nblocks);
     123                 :             :         void            (*smgr_immedsync) (SMgrRelation reln, ForkNumber forknum);
     124                 :             :         void            (*smgr_registersync) (SMgrRelation reln, ForkNumber forknum);
     125                 :             :         int                     (*smgr_fd) (SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum, uint32 *off);
     126                 :             : } f_smgr;
     127                 :             : 
     128                 :             : static const f_smgr smgrsw[] = {
     129                 :             :         /* magnetic disk */
     130                 :             :         {
     131                 :             :                 .smgr_init = mdinit,
     132                 :             :                 .smgr_shutdown = NULL,
     133                 :             :                 .smgr_open = mdopen,
     134                 :             :                 .smgr_close = mdclose,
     135                 :             :                 .smgr_create = mdcreate,
     136                 :             :                 .smgr_exists = mdexists,
     137                 :             :                 .smgr_unlink = mdunlink,
     138                 :             :                 .smgr_extend = mdextend,
     139                 :             :                 .smgr_zeroextend = mdzeroextend,
     140                 :             :                 .smgr_prefetch = mdprefetch,
     141                 :             :                 .smgr_maxcombine = mdmaxcombine,
     142                 :             :                 .smgr_readv = mdreadv,
     143                 :             :                 .smgr_startreadv = mdstartreadv,
     144                 :             :                 .smgr_writev = mdwritev,
     145                 :             :                 .smgr_writeback = mdwriteback,
     146                 :             :                 .smgr_nblocks = mdnblocks,
     147                 :             :                 .smgr_truncate = mdtruncate,
     148                 :             :                 .smgr_immedsync = mdimmedsync,
     149                 :             :                 .smgr_registersync = mdregistersync,
     150                 :             :                 .smgr_fd = mdfd,
     151                 :             :         }
     152                 :             : };
     153                 :             : 
     154                 :             : static const int NSmgr = lengthof(smgrsw);
     155                 :             : 
     156                 :             : /*
     157                 :             :  * Each backend has a hashtable that stores all extant SMgrRelation objects.
     158                 :             :  * In addition, "unpinned" SMgrRelation objects are chained together in a list.
     159                 :             :  */
     160                 :             : static HTAB *SMgrRelationHash = NULL;
     161                 :             : 
     162                 :             : static dlist_head unpinned_relns;
     163                 :             : 
     164                 :             : /* local function prototypes */
     165                 :             : static void smgrshutdown(int code, Datum arg);
     166                 :             : static void smgrdestroy(SMgrRelation reln);
     167                 :             : 
     168                 :             : static void smgr_aio_reopen(PgAioHandle *ioh);
     169                 :             : static char *smgr_aio_describe_identity(const PgAioTargetData *sd);
     170                 :             : 
     171                 :             : 
     172                 :             : const PgAioTargetInfo aio_smgr_target_info = {
     173                 :             :         .name = "smgr",
     174                 :             :         .reopen = smgr_aio_reopen,
     175                 :             :         .describe_identity = smgr_aio_describe_identity,
     176                 :             : };
     177                 :             : 
     178                 :             : 
     179                 :             : /*
     180                 :             :  * smgrinit(), smgrshutdown() -- Initialize or shut down storage
     181                 :             :  *                                                               managers.
     182                 :             :  *
     183                 :             :  * Note: smgrinit is called during backend startup (normal or standalone
     184                 :             :  * case), *not* during postmaster start.  Therefore, any resources created
     185                 :             :  * here or destroyed in smgrshutdown are backend-local.
     186                 :             :  */
     187                 :             : void
     188                 :         806 : smgrinit(void)
     189                 :             : {
     190                 :         806 :         int                     i;
     191                 :             : 
     192                 :         806 :         HOLD_INTERRUPTS();
     193                 :             : 
     194         [ +  + ]:        1612 :         for (i = 0; i < NSmgr; i++)
     195                 :             :         {
     196         [ -  + ]:         806 :                 if (smgrsw[i].smgr_init)
     197                 :         806 :                         smgrsw[i].smgr_init();
     198                 :         806 :         }
     199                 :             : 
     200         [ +  - ]:         806 :         RESUME_INTERRUPTS();
     201                 :             : 
     202                 :             :         /* register the shutdown proc */
     203                 :         806 :         on_proc_exit(smgrshutdown, 0);
     204                 :         806 : }
     205                 :             : 
     206                 :             : /*
     207                 :             :  * on_proc_exit hook for smgr cleanup during backend shutdown
     208                 :             :  */
     209                 :             : static void
     210                 :         806 : smgrshutdown(int code, Datum arg)
     211                 :             : {
     212                 :         806 :         int                     i;
     213                 :             : 
     214                 :         806 :         HOLD_INTERRUPTS();
     215                 :             : 
     216         [ +  + ]:        1612 :         for (i = 0; i < NSmgr; i++)
     217                 :             :         {
     218         [ +  - ]:         806 :                 if (smgrsw[i].smgr_shutdown)
     219                 :           0 :                         smgrsw[i].smgr_shutdown();
     220                 :         806 :         }
     221                 :             : 
     222         [ +  - ]:         806 :         RESUME_INTERRUPTS();
     223                 :         806 : }
     224                 :             : 
     225                 :             : /*
     226                 :             :  * smgropen() -- Return an SMgrRelation object, creating it if need be.
     227                 :             :  *
     228                 :             :  * In versions of PostgreSQL prior to 17, this function returned an object
     229                 :             :  * with no defined lifetime.  Now, however, the object remains valid for the
     230                 :             :  * lifetime of the transaction, up to the point where AtEOXact_SMgr() is
     231                 :             :  * called, making it much easier for callers to know for how long they can
     232                 :             :  * hold on to a pointer to the returned object.  If this function is called
     233                 :             :  * outside of a transaction, the object remains valid until smgrdestroy() or
     234                 :             :  * smgrdestroyall() is called.  Background processes that use smgr but not
     235                 :             :  * transactions typically do this once per checkpoint cycle.
     236                 :             :  *
     237                 :             :  * This does not attempt to actually open the underlying files.
     238                 :             :  */
     239                 :             : SMgrRelation
     240                 :      116653 : smgropen(RelFileLocator rlocator, ProcNumber backend)
     241                 :             : {
     242                 :      116653 :         RelFileLocatorBackend brlocator;
     243                 :      116653 :         SMgrRelation reln;
     244                 :      116653 :         bool            found;
     245                 :             : 
     246         [ +  - ]:      116653 :         Assert(RelFileNumberIsValid(rlocator.relNumber));
     247                 :             : 
     248                 :      116653 :         HOLD_INTERRUPTS();
     249                 :             : 
     250         [ +  + ]:      116653 :         if (SMgrRelationHash == NULL)
     251                 :             :         {
     252                 :             :                 /* First time through: initialize the hash table */
     253                 :         801 :                 HASHCTL         ctl;
     254                 :             : 
     255                 :         801 :                 ctl.keysize = sizeof(RelFileLocatorBackend);
     256                 :         801 :                 ctl.entrysize = sizeof(SMgrRelationData);
     257                 :         801 :                 SMgrRelationHash = hash_create("smgr relation table", 400,
     258                 :             :                                                                            &ctl, HASH_ELEM | HASH_BLOBS);
     259                 :         801 :                 dlist_init(&unpinned_relns);
     260                 :         801 :         }
     261                 :             : 
     262                 :             :         /* Look up or create an entry */
     263                 :      116653 :         brlocator.locator = rlocator;
     264                 :      116653 :         brlocator.backend = backend;
     265                 :      116653 :         reln = (SMgrRelation) hash_search(SMgrRelationHash,
     266                 :             :                                                                           &brlocator,
     267                 :             :                                                                           HASH_ENTER, &found);
     268                 :             : 
     269                 :             :         /* Initialize it if not present before */
     270         [ +  + ]:      116653 :         if (!found)
     271                 :             :         {
     272                 :             :                 /* hash_search already filled in the lookup key */
     273                 :       65565 :                 reln->smgr_targblock = InvalidBlockNumber;
     274         [ +  + ]:      327825 :                 for (int i = 0; i <= MAX_FORKNUM; ++i)
     275                 :      262260 :                         reln->smgr_cached_nblocks[i] = InvalidBlockNumber;
     276                 :       65565 :                 reln->smgr_which = 0;        /* we only have md.c at present */
     277                 :             : 
     278                 :             :                 /* it is not pinned yet */
     279                 :       65565 :                 reln->pincount = 0;
     280                 :       65565 :                 dlist_push_tail(&unpinned_relns, &reln->node);
     281                 :             : 
     282                 :             :                 /* implementation-specific initialization */
     283                 :       65565 :                 smgrsw[reln->smgr_which].smgr_open(reln);
     284                 :       65565 :         }
     285                 :             : 
     286         [ -  + ]:      116653 :         RESUME_INTERRUPTS();
     287                 :             : 
     288                 :      233306 :         return reln;
     289                 :      116653 : }
     290                 :             : 
     291                 :             : /*
     292                 :             :  * smgrpin() -- Prevent an SMgrRelation object from being destroyed at end of
     293                 :             :  *                              transaction
     294                 :             :  */
     295                 :             : void
     296                 :       64990 : smgrpin(SMgrRelation reln)
     297                 :             : {
     298         [ -  + ]:       64990 :         if (reln->pincount == 0)
     299                 :       64990 :                 dlist_delete(&reln->node);
     300                 :       64990 :         reln->pincount++;
     301                 :       64990 : }
     302                 :             : 
     303                 :             : /*
     304                 :             :  * smgrunpin() -- Allow an SMgrRelation object to be destroyed at end of
     305                 :             :  *                                transaction
     306                 :             :  *
     307                 :             :  * The object remains valid, but if there are no other pins on it, it is moved
     308                 :             :  * to the unpinned list where it will be destroyed by AtEOXact_SMgr().
     309                 :             :  */
     310                 :             : void
     311                 :       29293 : smgrunpin(SMgrRelation reln)
     312                 :             : {
     313         [ +  - ]:       29293 :         Assert(reln->pincount > 0);
     314                 :       29293 :         reln->pincount--;
     315         [ -  + ]:       29293 :         if (reln->pincount == 0)
     316                 :       29293 :                 dlist_push_tail(&unpinned_relns, &reln->node);
     317                 :       29293 : }
     318                 :             : 
     319                 :             : /*
     320                 :             :  * smgrdestroy() -- Delete an SMgrRelation object.
     321                 :             :  */
     322                 :             : static void
     323                 :       29436 : smgrdestroy(SMgrRelation reln)
     324                 :             : {
     325                 :       29436 :         ForkNumber      forknum;
     326                 :             : 
     327         [ +  - ]:       29436 :         Assert(reln->pincount == 0);
     328                 :             : 
     329                 :       29436 :         HOLD_INTERRUPTS();
     330                 :             : 
     331         [ +  + ]:      147180 :         for (forknum = 0; forknum <= MAX_FORKNUM; forknum++)
     332                 :      117744 :                 smgrsw[reln->smgr_which].smgr_close(reln, forknum);
     333                 :             : 
     334                 :       29436 :         dlist_delete(&reln->node);
     335                 :             : 
     336                 :       58872 :         if (hash_search(SMgrRelationHash,
     337                 :       29436 :                                         &(reln->smgr_rlocator),
     338         [ +  - ]:       29436 :                                         HASH_REMOVE, NULL) == NULL)
     339   [ #  #  #  # ]:           0 :                 elog(ERROR, "SMgrRelation hashtable corrupted");
     340                 :             : 
     341         [ +  - ]:       29436 :         RESUME_INTERRUPTS();
     342                 :       29436 : }
     343                 :             : 
     344                 :             : /*
     345                 :             :  * smgrrelease() -- Release all resources used by this object.
     346                 :             :  *
     347                 :             :  * The object remains valid.
     348                 :             :  */
     349                 :             : void
     350                 :       58851 : smgrrelease(SMgrRelation reln)
     351                 :             : {
     352                 :       58851 :         HOLD_INTERRUPTS();
     353                 :             : 
     354         [ +  + ]:      294255 :         for (ForkNumber forknum = 0; forknum <= MAX_FORKNUM; forknum++)
     355                 :             :         {
     356                 :      235404 :                 smgrsw[reln->smgr_which].smgr_close(reln, forknum);
     357                 :      235404 :                 reln->smgr_cached_nblocks[forknum] = InvalidBlockNumber;
     358                 :      235404 :         }
     359                 :       58851 :         reln->smgr_targblock = InvalidBlockNumber;
     360                 :             : 
     361         [ +  - ]:       58851 :         RESUME_INTERRUPTS();
     362                 :       58851 : }
     363                 :             : 
     364                 :             : /*
     365                 :             :  * smgrclose() -- Close an SMgrRelation object.
     366                 :             :  *
     367                 :             :  * The SMgrRelation reference should not be used after this call.  However,
     368                 :             :  * because we don't keep track of the references returned by smgropen(), we
     369                 :             :  * don't know if there are other references still pointing to the same object,
     370                 :             :  * so we cannot remove the SMgrRelation object yet.  Therefore, this is just a
     371                 :             :  * synonym for smgrrelease() at the moment.
     372                 :             :  */
     373                 :             : void
     374                 :       45420 : smgrclose(SMgrRelation reln)
     375                 :             : {
     376                 :       45420 :         smgrrelease(reln);
     377                 :       45420 : }
     378                 :             : 
     379                 :             : /*
     380                 :             :  * smgrdestroyall() -- Release resources used by all unpinned objects.
     381                 :             :  *
     382                 :             :  * It must be known that there are no pointers to SMgrRelations, other than
     383                 :             :  * those pinned with smgrpin().
     384                 :             :  */
     385                 :             : void
     386                 :       57918 : smgrdestroyall(void)
     387                 :             : {
     388                 :       57918 :         dlist_mutable_iter iter;
     389                 :             : 
     390                 :             :         /* seems unsafe to accept interrupts while in a dlist_foreach_modify() */
     391                 :       57918 :         HOLD_INTERRUPTS();
     392                 :             : 
     393                 :             :         /*
     394                 :             :          * Zap all unpinned SMgrRelations.  We rely on smgrdestroy() to remove
     395                 :             :          * each one from the list.
     396                 :             :          */
     397   [ +  +  +  + ]:       87354 :         dlist_foreach_modify(iter, &unpinned_relns)
     398                 :             :         {
     399                 :       29436 :                 SMgrRelation rel = dlist_container(SMgrRelationData, node,
     400                 :             :                                                                                    iter.cur);
     401                 :             : 
     402                 :       29436 :                 smgrdestroy(rel);
     403                 :       29436 :         }
     404                 :             : 
     405         [ +  - ]:       57918 :         RESUME_INTERRUPTS();
     406                 :       57918 : }
     407                 :             : 
     408                 :             : /*
     409                 :             :  * smgrreleaseall() -- Release resources used by all objects.
     410                 :             :  */
     411                 :             : void
     412                 :         575 : smgrreleaseall(void)
     413                 :             : {
     414                 :         575 :         HASH_SEQ_STATUS status;
     415                 :         575 :         SMgrRelation reln;
     416                 :             : 
     417                 :             :         /* Nothing to do if hashtable not set up */
     418         [ +  - ]:         575 :         if (SMgrRelationHash == NULL)
     419                 :           0 :                 return;
     420                 :             : 
     421                 :             :         /* seems unsafe to accept interrupts while iterating */
     422                 :         575 :         HOLD_INTERRUPTS();
     423                 :             : 
     424                 :         575 :         hash_seq_init(&status, SMgrRelationHash);
     425                 :             : 
     426         [ +  + ]:       13494 :         while ((reln = (SMgrRelation) hash_seq_search(&status)) != NULL)
     427                 :             :         {
     428                 :       12919 :                 smgrrelease(reln);
     429                 :             :         }
     430                 :             : 
     431         [ +  - ]:         575 :         RESUME_INTERRUPTS();
     432         [ -  + ]:         575 : }
     433                 :             : 
     434                 :             : /*
     435                 :             :  * smgrreleaserellocator() -- Release resources for given RelFileLocator, if
     436                 :             :  *                                                        it's open.
     437                 :             :  *
     438                 :             :  * This has the same effects as smgrrelease(smgropen(rlocator)), but avoids
     439                 :             :  * uselessly creating a hashtable entry only to drop it again when no
     440                 :             :  * such entry exists already.
     441                 :             :  */
     442                 :             : void
     443                 :       45422 : smgrreleaserellocator(RelFileLocatorBackend rlocator)
     444                 :             : {
     445                 :       45422 :         SMgrRelation reln;
     446                 :             : 
     447                 :             :         /* Nothing to do if hashtable not set up */
     448         [ +  + ]:       45422 :         if (SMgrRelationHash == NULL)
     449                 :           7 :                 return;
     450                 :             : 
     451                 :       45415 :         reln = (SMgrRelation) hash_search(SMgrRelationHash,
     452                 :             :                                                                           &rlocator,
     453                 :             :                                                                           HASH_FIND, NULL);
     454         [ +  + ]:       45415 :         if (reln != NULL)
     455                 :         512 :                 smgrrelease(reln);
     456         [ -  + ]:       45422 : }
     457                 :             : 
     458                 :             : /*
     459                 :             :  * smgrexists() -- Does the underlying file for a fork exist?
     460                 :             :  */
     461                 :             : bool
     462                 :       58540 : smgrexists(SMgrRelation reln, ForkNumber forknum)
     463                 :             : {
     464                 :       58540 :         bool            ret;
     465                 :             : 
     466                 :       58540 :         HOLD_INTERRUPTS();
     467                 :       58540 :         ret = smgrsw[reln->smgr_which].smgr_exists(reln, forknum);
     468         [ +  - ]:       58540 :         RESUME_INTERRUPTS();
     469                 :             : 
     470                 :      117080 :         return ret;
     471                 :       58540 : }
     472                 :             : 
     473                 :             : /*
     474                 :             :  * smgrcreate() -- Create a new relation.
     475                 :             :  *
     476                 :             :  * Given an already-created (but presumably unused) SMgrRelation,
     477                 :             :  * cause the underlying disk file or other storage for the fork
     478                 :             :  * to be created.
     479                 :             :  */
     480                 :             : void
     481                 :       12496 : smgrcreate(SMgrRelation reln, ForkNumber forknum, bool isRedo)
     482                 :             : {
     483                 :       12496 :         HOLD_INTERRUPTS();
     484                 :       12496 :         smgrsw[reln->smgr_which].smgr_create(reln, forknum, isRedo);
     485         [ +  - ]:       12496 :         RESUME_INTERRUPTS();
     486                 :       12496 : }
     487                 :             : 
     488                 :             : /*
     489                 :             :  * smgrdosyncall() -- Immediately sync all forks of all given relations
     490                 :             :  *
     491                 :             :  * All forks of all given relations are synced out to the store.
     492                 :             :  *
     493                 :             :  * This is equivalent to FlushRelationBuffers() for each smgr relation,
     494                 :             :  * then calling smgrimmedsync() for all forks of each relation, but it's
     495                 :             :  * significantly quicker so should be preferred when possible.
     496                 :             :  */
     497                 :             : void
     498                 :           8 : smgrdosyncall(SMgrRelation *rels, int nrels)
     499                 :             : {
     500                 :           8 :         int                     i = 0;
     501                 :           8 :         ForkNumber      forknum;
     502                 :             : 
     503         [ +  - ]:           8 :         if (nrels == 0)
     504                 :           0 :                 return;
     505                 :             : 
     506                 :           8 :         FlushRelationsAllBuffers(rels, nrels);
     507                 :             : 
     508                 :           8 :         HOLD_INTERRUPTS();
     509                 :             : 
     510                 :             :         /*
     511                 :             :          * Sync the physical file(s).
     512                 :             :          */
     513         [ +  + ]:          16 :         for (i = 0; i < nrels; i++)
     514                 :             :         {
     515                 :           8 :                 int                     which = rels[i]->smgr_which;
     516                 :             : 
     517         [ +  + ]:          40 :                 for (forknum = 0; forknum <= MAX_FORKNUM; forknum++)
     518                 :             :                 {
     519         [ +  + ]:          32 :                         if (smgrsw[which].smgr_exists(rels[i], forknum))
     520                 :           8 :                                 smgrsw[which].smgr_immedsync(rels[i], forknum);
     521                 :          32 :                 }
     522                 :           8 :         }
     523                 :             : 
     524         [ +  - ]:           8 :         RESUME_INTERRUPTS();
     525         [ -  + ]:           8 : }
     526                 :             : 
     527                 :             : /*
     528                 :             :  * smgrdounlinkall() -- Immediately unlink all forks of all given relations
     529                 :             :  *
     530                 :             :  * All forks of all given relations are removed from the store.  This
     531                 :             :  * should not be used during transactional operations, since it can't be
     532                 :             :  * undone.
     533                 :             :  *
     534                 :             :  * If isRedo is true, it is okay for the underlying file(s) to be gone
     535                 :             :  * already.
     536                 :             :  */
     537                 :             : void
     538                 :        2704 : smgrdounlinkall(SMgrRelation *rels, int nrels, bool isRedo)
     539                 :             : {
     540                 :        2704 :         int                     i = 0;
     541                 :        2704 :         RelFileLocatorBackend *rlocators;
     542                 :        2704 :         ForkNumber      forknum;
     543                 :             : 
     544         [ +  - ]:        2704 :         if (nrels == 0)
     545                 :           0 :                 return;
     546                 :             : 
     547                 :             :         /*
     548                 :             :          * It would be unsafe to process interrupts between DropRelationBuffers()
     549                 :             :          * and unlinking the underlying files. This probably should be a critical
     550                 :             :          * section, but we're not there yet.
     551                 :             :          */
     552                 :        2704 :         HOLD_INTERRUPTS();
     553                 :             : 
     554                 :             :         /*
     555                 :             :          * Get rid of any remaining buffers for the relations.  bufmgr will just
     556                 :             :          * drop them without bothering to write the contents.
     557                 :             :          */
     558                 :        2704 :         DropRelationsAllBuffers(rels, nrels);
     559                 :             : 
     560                 :             :         /*
     561                 :             :          * create an array which contains all relations to be dropped, and close
     562                 :             :          * each relation's forks at the smgr level while at it
     563                 :             :          */
     564                 :        2704 :         rlocators = palloc_array(RelFileLocatorBackend, nrels);
     565         [ +  + ]:       11628 :         for (i = 0; i < nrels; i++)
     566                 :             :         {
     567                 :        8924 :                 RelFileLocatorBackend rlocator = rels[i]->smgr_rlocator;
     568                 :        8924 :                 int                     which = rels[i]->smgr_which;
     569                 :             : 
     570                 :        8924 :                 rlocators[i] = rlocator;
     571                 :             : 
     572                 :             :                 /* Close the forks at smgr level */
     573         [ +  + ]:       44620 :                 for (forknum = 0; forknum <= MAX_FORKNUM; forknum++)
     574                 :       35696 :                         smgrsw[which].smgr_close(rels[i], forknum);
     575                 :        8924 :         }
     576                 :             : 
     577                 :             :         /*
     578                 :             :          * Send a shared-inval message to force other backends to close any
     579                 :             :          * dangling smgr references they may have for these rels.  We should do
     580                 :             :          * this before starting the actual unlinking, in case we fail partway
     581                 :             :          * through that step.  Note that the sinval messages will eventually come
     582                 :             :          * back to this backend, too, and thereby provide a backstop that we
     583                 :             :          * closed our own smgr rel.
     584                 :             :          */
     585         [ +  + ]:       11628 :         for (i = 0; i < nrels; i++)
     586                 :        8924 :                 CacheInvalidateSmgr(rlocators[i]);
     587                 :             : 
     588                 :             :         /*
     589                 :             :          * Delete the physical file(s).
     590                 :             :          *
     591                 :             :          * Note: smgr_unlink must treat deletion failure as a WARNING, not an
     592                 :             :          * ERROR, because we've already decided to commit or abort the current
     593                 :             :          * xact.
     594                 :             :          */
     595                 :             : 
     596         [ +  + ]:       11628 :         for (i = 0; i < nrels; i++)
     597                 :             :         {
     598                 :        8924 :                 int                     which = rels[i]->smgr_which;
     599                 :             : 
     600         [ +  + ]:       44620 :                 for (forknum = 0; forknum <= MAX_FORKNUM; forknum++)
     601                 :       35696 :                         smgrsw[which].smgr_unlink(rlocators[i], forknum, isRedo);
     602                 :        8924 :         }
     603                 :             : 
     604                 :        2704 :         pfree(rlocators);
     605                 :             : 
     606         [ +  - ]:        2704 :         RESUME_INTERRUPTS();
     607         [ -  + ]:        2704 : }
     608                 :             : 
     609                 :             : 
     610                 :             : /*
     611                 :             :  * smgrextend() -- Add a new block to a file.
     612                 :             :  *
     613                 :             :  * The semantics are nearly the same as smgrwrite(): write at the
     614                 :             :  * specified position.  However, this is to be used for the case of
     615                 :             :  * extending a relation (i.e., blocknum is at or beyond the current
     616                 :             :  * EOF).  Note that we assume writing a block beyond current EOF
     617                 :             :  * causes intervening file space to become filled with zeroes.
     618                 :             :  */
     619                 :             : void
     620                 :       10470 : smgrextend(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum,
     621                 :             :                    const void *buffer, bool skipFsync)
     622                 :             : {
     623                 :       10470 :         HOLD_INTERRUPTS();
     624                 :             : 
     625                 :       20940 :         smgrsw[reln->smgr_which].smgr_extend(reln, forknum, blocknum,
     626                 :       10470 :                                                                                  buffer, skipFsync);
     627                 :             : 
     628                 :             :         /*
     629                 :             :          * Normally we expect this to increase nblocks by one, but if the cached
     630                 :             :          * value isn't as expected, just invalidate it so the next call asks the
     631                 :             :          * kernel.
     632                 :             :          */
     633         [ +  + ]:       10470 :         if (reln->smgr_cached_nblocks[forknum] == blocknum)
     634                 :        9723 :                 reln->smgr_cached_nblocks[forknum] = blocknum + 1;
     635                 :             :         else
     636                 :         747 :                 reln->smgr_cached_nblocks[forknum] = InvalidBlockNumber;
     637                 :             : 
     638         [ +  - ]:       10470 :         RESUME_INTERRUPTS();
     639                 :       10470 : }
     640                 :             : 
     641                 :             : /*
     642                 :             :  * smgrzeroextend() -- Add new zeroed out blocks to a file.
     643                 :             :  *
     644                 :             :  * Similar to smgrextend(), except the relation can be extended by
     645                 :             :  * multiple blocks at once and the added blocks will be filled with
     646                 :             :  * zeroes.
     647                 :             :  */
     648                 :             : void
     649                 :       27454 : smgrzeroextend(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum,
     650                 :             :                            int nblocks, bool skipFsync)
     651                 :             : {
     652                 :       27454 :         HOLD_INTERRUPTS();
     653                 :             : 
     654                 :       54908 :         smgrsw[reln->smgr_which].smgr_zeroextend(reln, forknum, blocknum,
     655                 :       27454 :                                                                                          nblocks, skipFsync);
     656                 :             : 
     657                 :             :         /*
     658                 :             :          * Normally we expect this to increase the fork size by nblocks, but if
     659                 :             :          * the cached value isn't as expected, just invalidate it so the next call
     660                 :             :          * asks the kernel.
     661                 :             :          */
     662         [ +  - ]:       27454 :         if (reln->smgr_cached_nblocks[forknum] == blocknum)
     663                 :       27454 :                 reln->smgr_cached_nblocks[forknum] = blocknum + nblocks;
     664                 :             :         else
     665                 :           0 :                 reln->smgr_cached_nblocks[forknum] = InvalidBlockNumber;
     666                 :             : 
     667         [ +  - ]:       27454 :         RESUME_INTERRUPTS();
     668                 :       27454 : }
     669                 :             : 
     670                 :             : /*
     671                 :             :  * smgrprefetch() -- Initiate asynchronous read of the specified block of a relation.
     672                 :             :  *
     673                 :             :  * In recovery only, this can return false to indicate that a file
     674                 :             :  * doesn't exist (presumably it has been dropped by a later WAL
     675                 :             :  * record).
     676                 :             :  */
     677                 :             : bool
     678                 :           0 : smgrprefetch(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum,
     679                 :             :                          int nblocks)
     680                 :             : {
     681                 :           0 :         bool            ret;
     682                 :             : 
     683                 :           0 :         HOLD_INTERRUPTS();
     684                 :           0 :         ret = smgrsw[reln->smgr_which].smgr_prefetch(reln, forknum, blocknum, nblocks);
     685         [ #  # ]:           0 :         RESUME_INTERRUPTS();
     686                 :             : 
     687                 :           0 :         return ret;
     688                 :           0 : }
     689                 :             : 
     690                 :             : /*
     691                 :             :  * smgrmaxcombine() - Return the maximum number of total blocks that can be
     692                 :             :  *                               combined with an IO starting at blocknum.
     693                 :             :  *
     694                 :             :  * The returned value includes the IO for blocknum itself.
     695                 :             :  */
     696                 :             : uint32
     697                 :         639 : smgrmaxcombine(SMgrRelation reln, ForkNumber forknum,
     698                 :             :                            BlockNumber blocknum)
     699                 :             : {
     700                 :         639 :         uint32          ret;
     701                 :             : 
     702                 :         639 :         HOLD_INTERRUPTS();
     703                 :         639 :         ret = smgrsw[reln->smgr_which].smgr_maxcombine(reln, forknum, blocknum);
     704         [ +  - ]:         639 :         RESUME_INTERRUPTS();
     705                 :             : 
     706                 :        1278 :         return ret;
     707                 :         639 : }
     708                 :             : 
     709                 :             : /*
     710                 :             :  * smgrreadv() -- read a particular block range from a relation into the
     711                 :             :  *                               supplied buffers.
     712                 :             :  *
     713                 :             :  * This routine is called from the buffer manager in order to
     714                 :             :  * instantiate pages in the shared buffer cache.  All storage managers
     715                 :             :  * return pages in the format that POSTGRES expects.
     716                 :             :  *
     717                 :             :  * If more than one block is intended to be read, callers need to use
     718                 :             :  * smgrmaxcombine() to check how many blocks can be combined into one IO.
     719                 :             :  */
     720                 :             : void
     721                 :         177 : smgrreadv(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum,
     722                 :             :                   void **buffers, BlockNumber nblocks)
     723                 :             : {
     724                 :         177 :         HOLD_INTERRUPTS();
     725                 :         354 :         smgrsw[reln->smgr_which].smgr_readv(reln, forknum, blocknum, buffers,
     726                 :         177 :                                                                                 nblocks);
     727         [ +  - ]:         177 :         RESUME_INTERRUPTS();
     728                 :         177 : }
     729                 :             : 
     730                 :             : /*
     731                 :             :  * smgrstartreadv() -- asynchronous version of smgrreadv()
     732                 :             :  *
     733                 :             :  * This starts an asynchronous readv IO using the IO handle `ioh`. Other than
     734                 :             :  * `ioh` all parameters are the same as smgrreadv().
     735                 :             :  *
     736                 :             :  * Completion callbacks above smgr will be passed the result as the number of
     737                 :             :  * successfully read blocks if the read [partially] succeeds (Buffers for
     738                 :             :  * blocks not successfully read might bear unspecified modifications, up to
     739                 :             :  * the full nblocks). This maintains the abstraction that smgr operates on the
     740                 :             :  * level of blocks, rather than bytes.
     741                 :             :  *
     742                 :             :  * Compared to smgrreadv(), more responsibilities fall on the caller:
     743                 :             :  * - Partial reads need to be handled by the caller re-issuing IO for the
     744                 :             :  *   unread blocks
     745                 :             :  * - smgr will ereport(LOG_SERVER_ONLY) some problems, but higher layers are
     746                 :             :  *   responsible for pgaio_result_report() to mirror that news to the user (if
     747                 :             :  *   the IO results in PGAIO_RS_WARNING) or abort the (sub)transaction (if
     748                 :             :  *   PGAIO_RS_ERROR).
     749                 :             :  * - Under Valgrind, the "buffers" memory may or may not change status to
     750                 :             :  *   DEFINED, depending on io_method and concurrent activity.
     751                 :             :  */
     752                 :             : void
     753                 :        7052 : smgrstartreadv(PgAioHandle *ioh,
     754                 :             :                            SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum,
     755                 :             :                            void **buffers, BlockNumber nblocks)
     756                 :             : {
     757                 :        7052 :         HOLD_INTERRUPTS();
     758                 :       14104 :         smgrsw[reln->smgr_which].smgr_startreadv(ioh,
     759                 :        7052 :                                                                                          reln, forknum, blocknum, buffers,
     760                 :        7052 :                                                                                          nblocks);
     761         [ +  - ]:        7052 :         RESUME_INTERRUPTS();
     762                 :        7052 : }
     763                 :             : 
     764                 :             : /*
     765                 :             :  * smgrwritev() -- Write the supplied buffers out.
     766                 :             :  *
     767                 :             :  * This is to be used only for updating already-existing blocks of a
     768                 :             :  * relation (ie, those before the current EOF).  To extend a relation,
     769                 :             :  * use smgrextend().
     770                 :             :  *
     771                 :             :  * This is not a synchronous write -- the block is not necessarily
     772                 :             :  * on disk at return, only dumped out to the kernel.  However,
     773                 :             :  * provisions will be made to fsync the write before the next checkpoint.
     774                 :             :  *
     775                 :             :  * NB: The mechanism to ensure fsync at next checkpoint assumes that there is
     776                 :             :  * something that prevents a concurrent checkpoint from "racing ahead" of the
     777                 :             :  * write.  One way to prevent that is by holding a lock on the buffer; the
     778                 :             :  * buffer manager's writes are protected by that.  The bulk writer facility
     779                 :             :  * in bulk_write.c checks the redo pointer and calls smgrimmedsync() if a
     780                 :             :  * checkpoint happened; that relies on the fact that no other backend can be
     781                 :             :  * concurrently modifying the page.
     782                 :             :  *
     783                 :             :  * skipFsync indicates that the caller will make other provisions to
     784                 :             :  * fsync the relation, so we needn't bother.  Temporary relations also
     785                 :             :  * do not require fsync.
     786                 :             :  *
     787                 :             :  * If more than one block is intended to be read, callers need to use
     788                 :             :  * smgrmaxcombine() to check how many blocks can be combined into one IO.
     789                 :             :  */
     790                 :             : void
     791                 :        8001 : smgrwritev(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum,
     792                 :             :                    const void **buffers, BlockNumber nblocks, bool skipFsync)
     793                 :             : {
     794                 :        8001 :         HOLD_INTERRUPTS();
     795                 :       16002 :         smgrsw[reln->smgr_which].smgr_writev(reln, forknum, blocknum,
     796                 :        8001 :                                                                                  buffers, nblocks, skipFsync);
     797         [ +  - ]:        8001 :         RESUME_INTERRUPTS();
     798                 :        8001 : }
     799                 :             : 
     800                 :             : /*
     801                 :             :  * smgrwriteback() -- Trigger kernel writeback for the supplied range of
     802                 :             :  *                                         blocks.
     803                 :             :  */
     804                 :             : void
     805                 :           0 : smgrwriteback(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum,
     806                 :             :                           BlockNumber nblocks)
     807                 :             : {
     808                 :           0 :         HOLD_INTERRUPTS();
     809                 :           0 :         smgrsw[reln->smgr_which].smgr_writeback(reln, forknum, blocknum,
     810                 :           0 :                                                                                         nblocks);
     811         [ #  # ]:           0 :         RESUME_INTERRUPTS();
     812                 :           0 : }
     813                 :             : 
     814                 :             : /*
     815                 :             :  * smgrnblocks() -- Calculate the number of blocks in the
     816                 :             :  *                                      supplied relation.
     817                 :             :  */
     818                 :             : BlockNumber
     819                 :      535079 : smgrnblocks(SMgrRelation reln, ForkNumber forknum)
     820                 :             : {
     821                 :      535079 :         BlockNumber result;
     822                 :             : 
     823                 :             :         /* Check and return if we get the cached value for the number of blocks. */
     824                 :      535079 :         result = smgrnblocks_cached(reln, forknum);
     825         [ -  + ]:      535079 :         if (result != InvalidBlockNumber)
     826                 :           0 :                 return result;
     827                 :             : 
     828                 :      535079 :         HOLD_INTERRUPTS();
     829                 :             : 
     830                 :      535079 :         result = smgrsw[reln->smgr_which].smgr_nblocks(reln, forknum);
     831                 :             : 
     832                 :      535079 :         reln->smgr_cached_nblocks[forknum] = result;
     833                 :             : 
     834         [ +  - ]:      535079 :         RESUME_INTERRUPTS();
     835                 :             : 
     836                 :      535079 :         return result;
     837                 :      535079 : }
     838                 :             : 
     839                 :             : /*
     840                 :             :  * smgrnblocks_cached() -- Get the cached number of blocks in the supplied
     841                 :             :  *                                                 relation.
     842                 :             :  *
     843                 :             :  * Returns an InvalidBlockNumber when not in recovery and when the relation
     844                 :             :  * fork size is not cached.
     845                 :             :  */
     846                 :             : BlockNumber
     847                 :      537562 : smgrnblocks_cached(SMgrRelation reln, ForkNumber forknum)
     848                 :             : {
     849                 :             :         /*
     850                 :             :          * For now, this function uses cached values only in recovery due to lack
     851                 :             :          * of a shared invalidation mechanism for changes in file size.  Code
     852                 :             :          * elsewhere reads smgr_cached_nblocks and copes with stale data.
     853                 :             :          */
     854   [ -  +  #  # ]:      537562 :         if (InRecovery && reln->smgr_cached_nblocks[forknum] != InvalidBlockNumber)
     855                 :           0 :                 return reln->smgr_cached_nblocks[forknum];
     856                 :             : 
     857                 :      537562 :         return InvalidBlockNumber;
     858                 :      537562 : }
     859                 :             : 
     860                 :             : /*
     861                 :             :  * smgrtruncate() -- Truncate the given forks of supplied relation to
     862                 :             :  *                                       each specified numbers of blocks
     863                 :             :  *
     864                 :             :  * The truncation is done immediately, so this can't be rolled back.
     865                 :             :  *
     866                 :             :  * The caller must hold AccessExclusiveLock on the relation, to ensure that
     867                 :             :  * other backends receive the smgr invalidation event that this function sends
     868                 :             :  * before they access any forks of the relation again.  The current size of
     869                 :             :  * the forks should be provided in old_nblocks.  This function should normally
     870                 :             :  * be called in a critical section, but the current size must be checked
     871                 :             :  * outside the critical section, and no interrupts or smgr functions relating
     872                 :             :  * to this relation should be called in between.
     873                 :             :  */
     874                 :             : void
     875                 :         155 : smgrtruncate(SMgrRelation reln, ForkNumber *forknum, int nforks,
     876                 :             :                          BlockNumber *old_nblocks, BlockNumber *nblocks)
     877                 :             : {
     878                 :         155 :         int                     i;
     879                 :             : 
     880                 :             :         /*
     881                 :             :          * Get rid of any buffers for the about-to-be-deleted blocks. bufmgr will
     882                 :             :          * just drop them without bothering to write the contents.
     883                 :             :          */
     884                 :         155 :         DropRelationBuffers(reln, forknum, nforks, nblocks);
     885                 :             : 
     886                 :             :         /*
     887                 :             :          * Send a shared-inval message to force other backends to close any smgr
     888                 :             :          * references they may have for this rel.  This is useful because they
     889                 :             :          * might have open file pointers to segments that got removed, and/or
     890                 :             :          * smgr_targblock variables pointing past the new rel end.  (The inval
     891                 :             :          * message will come back to our backend, too, causing a
     892                 :             :          * probably-unnecessary local smgr flush.  But we don't expect that this
     893                 :             :          * is a performance-critical path.)  As in the unlink code, we want to be
     894                 :             :          * sure the message is sent before we start changing things on-disk.
     895                 :             :          */
     896                 :         155 :         CacheInvalidateSmgr(reln->smgr_rlocator);
     897                 :             : 
     898                 :             :         /* Do the truncation */
     899         [ +  + ]:         355 :         for (i = 0; i < nforks; i++)
     900                 :             :         {
     901                 :             :                 /* Make the cached size is invalid if we encounter an error. */
     902                 :         200 :                 reln->smgr_cached_nblocks[forknum[i]] = InvalidBlockNumber;
     903                 :             : 
     904                 :         400 :                 smgrsw[reln->smgr_which].smgr_truncate(reln, forknum[i],
     905                 :         200 :                                                                                            old_nblocks[i], nblocks[i]);
     906                 :             : 
     907                 :             :                 /*
     908                 :             :                  * We might as well update the local smgr_cached_nblocks values. The
     909                 :             :                  * smgr cache inval message that this function sent will cause other
     910                 :             :                  * backends to invalidate their copies of smgr_cached_nblocks, and
     911                 :             :                  * these ones too at the next command boundary. But ensure they aren't
     912                 :             :                  * outright wrong until then.
     913                 :             :                  *
     914                 :             :                  * We can have nblocks > old_nblocks when a relation was truncated
     915                 :             :                  * multiple times, a replica applied all the truncations, and later
     916                 :             :                  * restarts from a restartpoint located before the truncations. The
     917                 :             :                  * relation on disk will be the size of the last truncate. When
     918                 :             :                  * replaying the first truncate, we will have nblocks > current size.
     919                 :             :                  * In such cases, smgr_truncate does nothing, so set the cached size
     920                 :             :                  * to the old size rather than the requested size.
     921                 :             :                  */
     922                 :         200 :                 reln->smgr_cached_nblocks[forknum[i]] =
     923         [ -  + ]:         200 :                         nblocks[i] > old_nblocks[i] ? old_nblocks[i] : nblocks[i];
     924                 :         200 :         }
     925                 :         155 : }
     926                 :             : 
     927                 :             : /*
     928                 :             :  * smgrregistersync() -- Request a relation to be sync'd at next checkpoint
     929                 :             :  *
     930                 :             :  * This can be used after calling smgrwrite() or smgrextend() with skipFsync =
     931                 :             :  * true, to register the fsyncs that were skipped earlier.
     932                 :             :  *
     933                 :             :  * Note: be mindful that a checkpoint could already have happened between the
     934                 :             :  * smgrwrite or smgrextend calls and this!  In that case, the checkpoint
     935                 :             :  * already missed fsyncing this relation, and you should use smgrimmedsync
     936                 :             :  * instead.  Most callers should use the bulk loading facility in bulk_write.c
     937                 :             :  * which handles all that.
     938                 :             :  */
     939                 :             : void
     940                 :        3498 : smgrregistersync(SMgrRelation reln, ForkNumber forknum)
     941                 :             : {
     942                 :        3498 :         HOLD_INTERRUPTS();
     943                 :        3498 :         smgrsw[reln->smgr_which].smgr_registersync(reln, forknum);
     944         [ +  - ]:        3498 :         RESUME_INTERRUPTS();
     945                 :        3498 : }
     946                 :             : 
     947                 :             : /*
     948                 :             :  * smgrimmedsync() -- Force the specified relation to stable storage.
     949                 :             :  *
     950                 :             :  * Synchronously force all previous writes to the specified relation
     951                 :             :  * down to disk.
     952                 :             :  *
     953                 :             :  * This is useful for building completely new relations (eg, new
     954                 :             :  * indexes).  Instead of incrementally WAL-logging the index build
     955                 :             :  * steps, we can just write completed index pages to disk with smgrwrite
     956                 :             :  * or smgrextend, and then fsync the completed index file before
     957                 :             :  * committing the transaction.  (This is sufficient for purposes of
     958                 :             :  * crash recovery, since it effectively duplicates forcing a checkpoint
     959                 :             :  * for the completed index.  But it is *not* sufficient if one wishes
     960                 :             :  * to use the WAL log for PITR or replication purposes: in that case
     961                 :             :  * we have to make WAL entries as well.)
     962                 :             :  *
     963                 :             :  * The preceding writes should specify skipFsync = true to avoid
     964                 :             :  * duplicative fsyncs.
     965                 :             :  *
     966                 :             :  * Note that you need to do FlushRelationBuffers() first if there is
     967                 :             :  * any possibility that there are dirty buffers for the relation;
     968                 :             :  * otherwise the sync is not very meaningful.
     969                 :             :  *
     970                 :             :  * Most callers should use the bulk loading facility in bulk_write.c
     971                 :             :  * instead of calling this directly.
     972                 :             :  */
     973                 :             : void
     974                 :           0 : smgrimmedsync(SMgrRelation reln, ForkNumber forknum)
     975                 :             : {
     976                 :           0 :         HOLD_INTERRUPTS();
     977                 :           0 :         smgrsw[reln->smgr_which].smgr_immedsync(reln, forknum);
     978         [ #  # ]:           0 :         RESUME_INTERRUPTS();
     979                 :           0 : }
     980                 :             : 
     981                 :             : /*
     982                 :             :  * Return fd for the specified block number and update *off to the appropriate
     983                 :             :  * position.
     984                 :             :  *
     985                 :             :  * This is only to be used for when AIO needs to perform the IO in a different
     986                 :             :  * process than where it was issued (e.g. in an IO worker).
     987                 :             :  */
     988                 :             : static int
     989                 :         287 : smgrfd(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum, uint32 *off)
     990                 :             : {
     991                 :         287 :         int                     fd;
     992                 :             : 
     993                 :             :         /*
     994                 :             :          * The caller needs to prevent interrupts from being processed, otherwise
     995                 :             :          * the FD could be closed prematurely.
     996                 :             :          */
     997   [ -  +  #  #  :         287 :         Assert(!INTERRUPTS_CAN_BE_PROCESSED());
                   #  # ]
     998                 :             : 
     999                 :         287 :         fd = smgrsw[reln->smgr_which].smgr_fd(reln, forknum, blocknum, off);
    1000                 :             : 
    1001                 :         574 :         return fd;
    1002                 :         287 : }
    1003                 :             : 
    1004                 :             : /*
    1005                 :             :  * AtEOXact_SMgr
    1006                 :             :  *
    1007                 :             :  * This routine is called during transaction commit or abort (it doesn't
    1008                 :             :  * particularly care which).  All unpinned SMgrRelation objects are destroyed.
    1009                 :             :  *
    1010                 :             :  * We do this as a compromise between wanting transient SMgrRelations to
    1011                 :             :  * live awhile (to amortize the costs of blind writes of multiple blocks)
    1012                 :             :  * and needing them to not live forever (since we're probably holding open
    1013                 :             :  * a kernel file descriptor for the underlying file, and we need to ensure
    1014                 :             :  * that gets closed reasonably soon if the file gets deleted).
    1015                 :             :  */
    1016                 :             : void
    1017                 :       57914 : AtEOXact_SMgr(void)
    1018                 :             : {
    1019                 :       57914 :         smgrdestroyall();
    1020                 :       57914 : }
    1021                 :             : 
    1022                 :             : /*
    1023                 :             :  * This routine is called when we are ordered to release all open files by a
    1024                 :             :  * ProcSignalBarrier.
    1025                 :             :  */
    1026                 :             : bool
    1027                 :           5 : ProcessBarrierSmgrRelease(void)
    1028                 :             : {
    1029                 :           5 :         smgrreleaseall();
    1030                 :           5 :         return true;
    1031                 :             : }
    1032                 :             : 
    1033                 :             : /*
    1034                 :             :  * Set target of the IO handle to be smgr and initialize all the relevant
    1035                 :             :  * pieces of data.
    1036                 :             :  */
    1037                 :             : void
    1038                 :        7052 : pgaio_io_set_target_smgr(PgAioHandle *ioh,
    1039                 :             :                                                  SMgrRelationData *smgr,
    1040                 :             :                                                  ForkNumber forknum,
    1041                 :             :                                                  BlockNumber blocknum,
    1042                 :             :                                                  int nblocks,
    1043                 :             :                                                  bool skip_fsync)
    1044                 :             : {
    1045                 :        7052 :         PgAioTargetData *sd = pgaio_io_get_target_data(ioh);
    1046                 :             : 
    1047                 :        7052 :         pgaio_io_set_target(ioh, PGAIO_TID_SMGR);
    1048                 :             : 
    1049                 :             :         /* backend is implied via IO owner */
    1050                 :        7052 :         sd->smgr.rlocator = smgr->smgr_rlocator.locator;
    1051                 :        7052 :         sd->smgr.forkNum = forknum;
    1052                 :        7052 :         sd->smgr.blockNum = blocknum;
    1053                 :        7052 :         sd->smgr.nblocks = nblocks;
    1054                 :        7052 :         sd->smgr.is_temp = SmgrIsTemp(smgr);
    1055                 :             :         /* Temp relations should never be fsync'd */
    1056         [ +  - ]:        7052 :         sd->smgr.skip_fsync = skip_fsync && !SmgrIsTemp(smgr);
    1057                 :        7052 : }
    1058                 :             : 
    1059                 :             : /*
    1060                 :             :  * Callback for the smgr AIO target, to reopen the file (e.g. because the IO
    1061                 :             :  * is executed in a worker).
    1062                 :             :  */
    1063                 :             : static void
    1064                 :         287 : smgr_aio_reopen(PgAioHandle *ioh)
    1065                 :             : {
    1066                 :         287 :         PgAioTargetData *sd = pgaio_io_get_target_data(ioh);
    1067                 :         287 :         PgAioOpData *od = pgaio_io_get_op_data(ioh);
    1068                 :         287 :         SMgrRelation reln;
    1069                 :         287 :         ProcNumber      procno;
    1070                 :         287 :         uint32          off;
    1071                 :             : 
    1072                 :             :         /*
    1073                 :             :          * The caller needs to prevent interrupts from being processed, otherwise
    1074                 :             :          * the FD could be closed again before we get to executing the IO.
    1075                 :             :          */
    1076   [ -  +  #  #  :         287 :         Assert(!INTERRUPTS_CAN_BE_PROCESSED());
                   #  # ]
    1077                 :             : 
    1078         [ -  + ]:         287 :         if (sd->smgr.is_temp)
    1079                 :           0 :                 procno = pgaio_io_get_owner(ioh);
    1080                 :             :         else
    1081                 :         287 :                 procno = INVALID_PROC_NUMBER;
    1082                 :             : 
    1083                 :         287 :         reln = smgropen(sd->smgr.rlocator, procno);
    1084   [ -  -  +  - ]:         287 :         switch (pgaio_io_get_op(ioh))
    1085                 :             :         {
    1086                 :             :                 case PGAIO_OP_INVALID:
    1087                 :           0 :                         pg_unreachable();
    1088                 :             :                         break;
    1089                 :             :                 case PGAIO_OP_READV:
    1090                 :         287 :                         od->read.fd = smgrfd(reln, sd->smgr.forkNum, sd->smgr.blockNum, &off);
    1091         [ +  - ]:         287 :                         Assert(off == od->read.offset);
    1092                 :         287 :                         break;
    1093                 :             :                 case PGAIO_OP_WRITEV:
    1094                 :           0 :                         od->write.fd = smgrfd(reln, sd->smgr.forkNum, sd->smgr.blockNum, &off);
    1095         [ #  # ]:           0 :                         Assert(off == od->write.offset);
    1096                 :           0 :                         break;
    1097                 :             :         }
    1098                 :         287 : }
    1099                 :             : 
    1100                 :             : /*
    1101                 :             :  * Callback for the smgr AIO target, describing the target of the IO.
    1102                 :             :  */
    1103                 :             : static char *
    1104                 :           0 : smgr_aio_describe_identity(const PgAioTargetData *sd)
    1105                 :             : {
    1106                 :           0 :         RelPathStr      path;
    1107                 :           0 :         char       *desc;
    1108                 :             : 
    1109         [ #  # ]:           0 :         path = relpathbackend(sd->smgr.rlocator,
    1110                 :             :                                                   sd->smgr.is_temp ?
    1111                 :             :                                                   MyProcNumber : INVALID_PROC_NUMBER,
    1112                 :             :                                                   sd->smgr.forkNum);
    1113                 :             : 
    1114         [ #  # ]:           0 :         if (sd->smgr.nblocks == 0)
    1115                 :           0 :                 desc = psprintf(_("file \"%s\""), path.str);
    1116         [ #  # ]:           0 :         else if (sd->smgr.nblocks == 1)
    1117                 :           0 :                 desc = psprintf(_("block %u in file \"%s\""),
    1118                 :           0 :                                                 sd->smgr.blockNum,
    1119                 :           0 :                                                 path.str);
    1120                 :             :         else
    1121                 :           0 :                 desc = psprintf(_("blocks %u..%u in file \"%s\""),
    1122                 :           0 :                                                 sd->smgr.blockNum,
    1123                 :           0 :                                                 sd->smgr.blockNum + sd->smgr.nblocks - 1,
    1124                 :           0 :                                                 path.str);
    1125                 :             : 
    1126                 :           0 :         return desc;
    1127                 :           0 : }
        

Generated by: LCOV version 2.3.2-1