LCOV - code coverage report
Current view: top level - src/backend/tcop - pquery.c (source / functions) Coverage Total Hit
Test: PostgreSQL 20devel Lines: 93.8 % 547 513
Test Date: 2026-10-03 01:15:54 Functions: 100.0 % 19 19
Legend: Lines:     hit not hit
Branches: + taken - not taken # not executed
Branches: 79.1 % 383 303

             Branch data     Line data    Source code
       1                 :             : /*-------------------------------------------------------------------------
       2                 :             :  *
       3                 :             :  * pquery.c
       4                 :             :  *    POSTGRES process query command code
       5                 :             :  *
       6                 :             :  * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
       7                 :             :  * Portions Copyright (c) 1994, Regents of the University of California
       8                 :             :  *
       9                 :             :  *
      10                 :             :  * IDENTIFICATION
      11                 :             :  *    src/backend/tcop/pquery.c
      12                 :             :  *
      13                 :             :  *-------------------------------------------------------------------------
      14                 :             :  */
      15                 :             : 
      16                 :             : #include "postgres.h"
      17                 :             : 
      18                 :             : #include <limits.h>
      19                 :             : 
      20                 :             : #include "access/xact.h"
      21                 :             : #include "commands/prepare.h"
      22                 :             : #include "executor/executor.h"
      23                 :             : #include "executor/tstoreReceiver.h"
      24                 :             : #include "miscadmin.h"
      25                 :             : #include "pg_trace.h"
      26                 :             : #include "tcop/pquery.h"
      27                 :             : #include "tcop/utility.h"
      28                 :             : #include "utils/memutils.h"
      29                 :             : #include "utils/snapmgr.h"
      30                 :             : 
      31                 :             : 
      32                 :             : /*
      33                 :             :  * ActivePortal is the currently executing Portal (the most closely nested,
      34                 :             :  * if there are several).
      35                 :             :  */
      36                 :             : Portal      ActivePortal = NULL;
      37                 :             : 
      38                 :             : 
      39                 :             : static void ProcessQuery(PlannedStmt *plan,
      40                 :             :                          const char *sourceText,
      41                 :             :                          ParamListInfo params,
      42                 :             :                          QueryEnvironment *queryEnv,
      43                 :             :                          DestReceiver *dest,
      44                 :             :                          QueryCompletion *qc);
      45                 :             : static void FillPortalStore(Portal portal, bool isTopLevel);
      46                 :             : static uint64 RunFromStore(Portal portal, ScanDirection direction, uint64 count,
      47                 :             :                            DestReceiver *dest);
      48                 :             : static uint64 PortalRunSelect(Portal portal, bool forward, long count,
      49                 :             :                               DestReceiver *dest);
      50                 :             : static void PortalRunUtility(Portal portal, PlannedStmt *pstmt,
      51                 :             :                              bool isTopLevel, bool setHoldSnapshot,
      52                 :             :                              DestReceiver *dest, QueryCompletion *qc);
      53                 :             : static void PortalRunMulti(Portal portal,
      54                 :             :                            bool isTopLevel, bool setHoldSnapshot,
      55                 :             :                            DestReceiver *dest, DestReceiver *altdest,
      56                 :             :                            QueryCompletion *qc);
      57                 :             : static uint64 DoPortalRunFetch(Portal portal,
      58                 :             :                                FetchDirection fdirection,
      59                 :             :                                long count,
      60                 :             :                                DestReceiver *dest);
      61                 :             : static void DoPortalRewind(Portal portal);
      62                 :             : 
      63                 :             : 
      64                 :             : /*
      65                 :             :  * CreateQueryDesc
      66                 :             :  */
      67                 :             : QueryDesc *
      68                 :      374749 : CreateQueryDesc(PlannedStmt *plannedstmt,
      69                 :             :                 const char *sourceText,
      70                 :             :                 Snapshot snapshot,
      71                 :             :                 Snapshot crosscheck_snapshot,
      72                 :             :                 DestReceiver *dest,
      73                 :             :                 ParamListInfo params,
      74                 :             :                 QueryEnvironment *queryEnv,
      75                 :             :                 int instrument_options)
      76                 :             : {
      77                 :      374749 :     QueryDesc  *qd = palloc_object(QueryDesc);
      78                 :             : 
      79                 :      374749 :     qd->operation = plannedstmt->commandType; /* operation */
      80                 :      374749 :     qd->plannedstmt = plannedstmt;   /* plan */
      81                 :      374749 :     qd->sourceText = sourceText; /* query text */
      82                 :      374749 :     qd->snapshot = RegisterSnapshot(snapshot);   /* snapshot */
      83                 :             :     /* RI check snapshot */
      84                 :      374749 :     qd->crosscheck_snapshot = RegisterSnapshot(crosscheck_snapshot);
      85                 :      374749 :     qd->dest = dest;         /* output dest */
      86                 :      374749 :     qd->params = params;     /* parameter values passed into query */
      87                 :      374749 :     qd->queryEnv = queryEnv;
      88                 :      374749 :     qd->instrument_options = instrument_options; /* instrumentation wanted? */
      89                 :      374749 :     qd->query_instr_options = 0;
      90                 :             : 
      91                 :             :     /* null these fields until set by ExecutorStart */
      92                 :      374749 :     qd->tupDesc = NULL;
      93                 :      374749 :     qd->estate = NULL;
      94                 :      374749 :     qd->planstate = NULL;
      95                 :      374749 :     qd->query_instr = NULL;
      96                 :             : 
      97                 :             :     /* not yet executed */
      98                 :      374749 :     qd->already_executed = false;
      99                 :             : 
     100                 :      374749 :     return qd;
     101                 :             : }
     102                 :             : 
     103                 :             : /*
     104                 :             :  * FreeQueryDesc
     105                 :             :  */
     106                 :             : void
     107                 :      355773 : FreeQueryDesc(QueryDesc *qdesc)
     108                 :             : {
     109                 :             :     /* Can't be a live query */
     110                 :             :     Assert(qdesc->estate == NULL);
     111                 :             : 
     112                 :             :     /* forget our snapshots */
     113                 :      355773 :     UnregisterSnapshot(qdesc->snapshot);
     114                 :      355773 :     UnregisterSnapshot(qdesc->crosscheck_snapshot);
     115                 :             : 
     116                 :             :     /* Only the QueryDesc itself need be freed */
     117                 :      355773 :     pfree(qdesc);
     118                 :      355773 : }
     119                 :             : 
     120                 :             : 
     121                 :             : /*
     122                 :             :  * ProcessQuery
     123                 :             :  *      Execute a single plannable query within a PORTAL_MULTI_QUERY,
     124                 :             :  *      PORTAL_ONE_RETURNING, or PORTAL_ONE_MOD_WITH portal
     125                 :             :  *
     126                 :             :  *  plan: the plan tree for the query
     127                 :             :  *  sourceText: the source text of the query
     128                 :             :  *  params: any parameters needed
     129                 :             :  *  dest: where to send results
     130                 :             :  *  qc: where to store the command completion status data.
     131                 :             :  *
     132                 :             :  * qc may be NULL if caller doesn't want a status string.
     133                 :             :  *
     134                 :             :  * Must be called in a memory context that will be reset or deleted on
     135                 :             :  * error; otherwise the executor's memory usage will be leaked.
     136                 :             :  */
     137                 :             : static void
     138                 :       55724 : ProcessQuery(PlannedStmt *plan,
     139                 :             :              const char *sourceText,
     140                 :             :              ParamListInfo params,
     141                 :             :              QueryEnvironment *queryEnv,
     142                 :             :              DestReceiver *dest,
     143                 :             :              QueryCompletion *qc)
     144                 :             : {
     145                 :             :     QueryDesc  *queryDesc;
     146                 :             : 
     147                 :             :     /*
     148                 :             :      * Create the QueryDesc object
     149                 :             :      */
     150                 :       55724 :     queryDesc = CreateQueryDesc(plan, sourceText,
     151                 :             :                                 GetActiveSnapshot(), InvalidSnapshot,
     152                 :             :                                 dest, params, queryEnv, 0);
     153                 :             : 
     154                 :             :     /*
     155                 :             :      * Call ExecutorStart to prepare the plan for execution
     156                 :             :      */
     157                 :       55724 :     ExecutorStart(queryDesc, 0);
     158                 :             : 
     159                 :             :     /*
     160                 :             :      * Run the plan to completion.
     161                 :             :      */
     162                 :       55031 :     ExecutorRun(queryDesc, ForwardScanDirection, 0);
     163                 :             : 
     164                 :             :     /*
     165                 :             :      * Build command completion status data, if caller wants one.
     166                 :             :      */
     167         [ +  + ]:       52856 :     if (qc)
     168                 :             :     {
     169                 :             :         CommandTag  tag;
     170                 :             : 
     171         [ +  + ]:       52416 :         if (queryDesc->operation == CMD_SELECT)
     172                 :          80 :             tag = CMDTAG_SELECT;
     173         [ +  + ]:       52336 :         else if (queryDesc->operation == CMD_INSERT)
     174                 :       42436 :             tag = CMDTAG_INSERT;
     175         [ +  + ]:        9900 :         else if (queryDesc->operation == CMD_UPDATE)
     176                 :        6884 :             tag = CMDTAG_UPDATE;
     177         [ +  + ]:        3016 :         else if (queryDesc->operation == CMD_DELETE)
     178                 :        2268 :             tag = CMDTAG_DELETE;
     179         [ +  - ]:         748 :         else if (queryDesc->operation == CMD_MERGE)
     180                 :         748 :             tag = CMDTAG_MERGE;
     181                 :             :         else
     182                 :           0 :             tag = CMDTAG_UNKNOWN;
     183                 :             : 
     184                 :       52416 :         SetQueryCompletion(qc, tag, queryDesc->estate->es_processed);
     185                 :             :     }
     186                 :             : 
     187                 :             :     /*
     188                 :             :      * Now, we close down all the scans and free allocated resources.
     189                 :             :      */
     190                 :       52856 :     ExecutorFinish(queryDesc);
     191                 :       52050 :     ExecutorEnd(queryDesc);
     192                 :             : 
     193                 :       52050 :     FreeQueryDesc(queryDesc);
     194                 :       52050 : }
     195                 :             : 
     196                 :             : /*
     197                 :             :  * ChoosePortalStrategy
     198                 :             :  *      Select portal execution strategy given the intended statement list.
     199                 :             :  *
     200                 :             :  * The list elements can be Querys or PlannedStmts.
     201                 :             :  * That's more general than portals need, but plancache.c uses this too.
     202                 :             :  *
     203                 :             :  * See the comments in portal.h.
     204                 :             :  */
     205                 :             : PortalStrategy
     206                 :      521115 : ChoosePortalStrategy(List *stmts)
     207                 :             : {
     208                 :             :     int         nSetTag;
     209                 :             :     ListCell   *lc;
     210                 :             : 
     211                 :             :     /*
     212                 :             :      * PORTAL_ONE_SELECT and PORTAL_UTIL_SELECT need only consider the
     213                 :             :      * single-statement case, since there are no rewrite rules that can add
     214                 :             :      * auxiliary queries to a SELECT or a utility command. PORTAL_ONE_MOD_WITH
     215                 :             :      * likewise allows only one top-level statement.
     216                 :             :      */
     217         [ +  + ]:      521115 :     if (list_length(stmts) == 1)
     218                 :             :     {
     219                 :      520867 :         Node       *stmt = (Node *) linitial(stmts);
     220                 :             : 
     221         [ +  + ]:      520867 :         if (IsA(stmt, Query))
     222                 :             :         {
     223                 :       51273 :             Query      *query = (Query *) stmt;
     224                 :             : 
     225         [ +  - ]:       51273 :             if (query->canSetTag)
     226                 :             :             {
     227         [ +  + ]:       51273 :                 if (query->commandType == CMD_SELECT)
     228                 :             :                 {
     229         [ -  + ]:       33928 :                     if (query->hasModifyingCTE)
     230                 :           0 :                         return PORTAL_ONE_MOD_WITH;
     231                 :             :                     else
     232                 :       33928 :                         return PORTAL_ONE_SELECT;
     233                 :             :                 }
     234         [ +  + ]:       17345 :                 if (query->commandType == CMD_UTILITY)
     235                 :             :                 {
     236         [ +  + ]:       12895 :                     if (UtilityReturnsTuples(query->utilityStmt))
     237                 :        6717 :                         return PORTAL_UTIL_SELECT;
     238                 :             :                     /* it can't be ONE_RETURNING, so give up */
     239                 :        6178 :                     return PORTAL_MULTI_QUERY;
     240                 :             :                 }
     241                 :             :             }
     242                 :             :         }
     243         [ +  - ]:      469594 :         else if (IsA(stmt, PlannedStmt))
     244                 :             :         {
     245                 :      469594 :             PlannedStmt *pstmt = (PlannedStmt *) stmt;
     246                 :             : 
     247         [ +  + ]:      469594 :             if (pstmt->canSetTag)
     248                 :             :             {
     249         [ +  + ]:      469570 :                 if (pstmt->commandType == CMD_SELECT)
     250                 :             :                 {
     251         [ +  + ]:      185258 :                     if (pstmt->hasModifyingCTE)
     252                 :          88 :                         return PORTAL_ONE_MOD_WITH;
     253                 :             :                     else
     254                 :      185170 :                         return PORTAL_ONE_SELECT;
     255                 :             :                 }
     256         [ +  + ]:      284312 :                 if (pstmt->commandType == CMD_UTILITY)
     257                 :             :                 {
     258         [ +  + ]:      229356 :                     if (UtilityReturnsTuples(pstmt->utilityStmt))
     259                 :       29616 :                         return PORTAL_UTIL_SELECT;
     260                 :             :                     /* it can't be ONE_RETURNING, so give up */
     261                 :      199740 :                     return PORTAL_MULTI_QUERY;
     262                 :             :                 }
     263                 :             :             }
     264                 :             :         }
     265                 :             :         else
     266         [ #  # ]:           0 :             elog(ERROR, "unrecognized node type: %d", (int) nodeTag(stmt));
     267                 :             :     }
     268                 :             : 
     269                 :             :     /*
     270                 :             :      * PORTAL_ONE_RETURNING has to allow auxiliary queries added by rewrite.
     271                 :             :      * Choose PORTAL_ONE_RETURNING if there is exactly one canSetTag query and
     272                 :             :      * it has a RETURNING list.
     273                 :             :      */
     274                 :       59678 :     nSetTag = 0;
     275   [ +  +  +  +  :       62115 :     foreach(lc, stmts)
                   +  + ]
     276                 :             :     {
     277                 :       59806 :         Node       *stmt = (Node *) lfirst(lc);
     278                 :             : 
     279         [ +  + ]:       59806 :         if (IsA(stmt, Query))
     280                 :             :         {
     281                 :        4458 :             Query      *query = (Query *) stmt;
     282                 :             : 
     283         [ +  + ]:        4458 :             if (query->canSetTag)
     284                 :             :             {
     285         [ -  + ]:        4454 :                 if (++nSetTag > 1)
     286                 :       57369 :                     return PORTAL_MULTI_QUERY;  /* no need to look further */
     287         [ +  - ]:        4454 :                 if (query->commandType == CMD_UTILITY ||
     288         [ +  + ]:        4454 :                     query->returningList == NIL)
     289                 :        4260 :                     return PORTAL_MULTI_QUERY;  /* no need to look further */
     290                 :             :             }
     291                 :             :         }
     292         [ +  - ]:       55348 :         else if (IsA(stmt, PlannedStmt))
     293                 :             :         {
     294                 :       55348 :             PlannedStmt *pstmt = (PlannedStmt *) stmt;
     295                 :             : 
     296         [ +  + ]:       55348 :             if (pstmt->canSetTag)
     297                 :             :             {
     298         [ -  + ]:       55192 :                 if (++nSetTag > 1)
     299                 :           0 :                     return PORTAL_MULTI_QUERY;  /* no need to look further */
     300         [ +  - ]:       55192 :                 if (pstmt->commandType == CMD_UTILITY ||
     301         [ +  + ]:       55192 :                     !pstmt->hasReturning)
     302                 :       53109 :                     return PORTAL_MULTI_QUERY;  /* no need to look further */
     303                 :             :             }
     304                 :             :         }
     305                 :             :         else
     306         [ #  # ]:           0 :             elog(ERROR, "unrecognized node type: %d", (int) nodeTag(stmt));
     307                 :             :     }
     308         [ +  + ]:        2309 :     if (nSetTag == 1)
     309                 :        2277 :         return PORTAL_ONE_RETURNING;
     310                 :             : 
     311                 :             :     /* Else, it's the general case... */
     312                 :          32 :     return PORTAL_MULTI_QUERY;
     313                 :             : }
     314                 :             : 
     315                 :             : /*
     316                 :             :  * FetchPortalTargetList
     317                 :             :  *      Given a portal that returns tuples, extract the query targetlist.
     318                 :             :  *      Returns NIL if the portal doesn't have a determinable targetlist.
     319                 :             :  *
     320                 :             :  * Note: do not modify the result.
     321                 :             :  */
     322                 :             : List *
     323                 :      199997 : FetchPortalTargetList(Portal portal)
     324                 :             : {
     325                 :             :     /* no point in looking if we determined it doesn't return tuples */
     326         [ +  + ]:      199997 :     if (portal->strategy == PORTAL_MULTI_QUERY)
     327                 :          20 :         return NIL;
     328                 :             :     /* get the primary statement and find out what it returns */
     329                 :      199977 :     return FetchStatementTargetList((Node *) PortalGetPrimaryStmt(portal));
     330                 :             : }
     331                 :             : 
     332                 :             : /*
     333                 :             :  * FetchStatementTargetList
     334                 :             :  *      Given a statement that returns tuples, extract the query targetlist.
     335                 :             :  *      Returns NIL if the statement doesn't have a determinable targetlist.
     336                 :             :  *
     337                 :             :  * This can be applied to a Query or a PlannedStmt.
     338                 :             :  * That's more general than portals need, but plancache.c uses this too.
     339                 :             :  *
     340                 :             :  * Note: do not modify the result.
     341                 :             :  *
     342                 :             :  * XXX be careful to keep this in sync with UtilityReturnsTuples.
     343                 :             :  */
     344                 :             : List *
     345                 :      208374 : FetchStatementTargetList(Node *stmt)
     346                 :             : {
     347         [ -  + ]:      208374 :     if (stmt == NULL)
     348                 :           0 :         return NIL;
     349         [ +  + ]:      208374 :     if (IsA(stmt, Query))
     350                 :             :     {
     351                 :        8397 :         Query      *query = (Query *) stmt;
     352                 :             : 
     353         [ +  + ]:        8397 :         if (query->commandType == CMD_UTILITY)
     354                 :             :         {
     355                 :             :             /* transfer attention to utility statement */
     356                 :           9 :             stmt = query->utilityStmt;
     357                 :             :         }
     358                 :             :         else
     359                 :             :         {
     360         [ +  + ]:        8388 :             if (query->commandType == CMD_SELECT)
     361                 :        8378 :                 return query->targetList;
     362         [ +  - ]:          10 :             if (query->returningList)
     363                 :          10 :                 return query->returningList;
     364                 :           0 :             return NIL;
     365                 :             :         }
     366                 :             :     }
     367         [ +  + ]:      199986 :     if (IsA(stmt, PlannedStmt))
     368                 :             :     {
     369                 :      199977 :         PlannedStmt *pstmt = (PlannedStmt *) stmt;
     370                 :             : 
     371         [ +  + ]:      199977 :         if (pstmt->commandType == CMD_UTILITY)
     372                 :             :         {
     373                 :             :             /* transfer attention to utility statement */
     374                 :       23959 :             stmt = pstmt->utilityStmt;
     375                 :             :         }
     376                 :             :         else
     377                 :             :         {
     378         [ +  + ]:      176018 :             if (pstmt->commandType == CMD_SELECT)
     379                 :      174075 :                 return pstmt->planTree->targetlist;
     380         [ +  - ]:        1943 :             if (pstmt->hasReturning)
     381                 :        1943 :                 return pstmt->planTree->targetlist;
     382                 :           0 :             return NIL;
     383                 :             :         }
     384                 :             :     }
     385         [ +  + ]:       23968 :     if (IsA(stmt, FetchStmt))
     386                 :             :     {
     387                 :        3248 :         FetchStmt  *fstmt = (FetchStmt *) stmt;
     388                 :             :         Portal      subportal;
     389                 :             : 
     390                 :             :         Assert(!fstmt->ismove);
     391                 :        3248 :         subportal = GetPortalByName(fstmt->portalname);
     392         [ +  + ]:        3248 :         if (!PortalIsValid(subportal))
     393         [ +  - ]:           1 :             ereport(ERROR,
     394                 :             :                     (errcode(ERRCODE_UNDEFINED_CURSOR),
     395                 :             :                      errmsg("cursor \"%s\" does not exist",
     396                 :             :                             fstmt->portalname)));
     397                 :        3247 :         return FetchPortalTargetList(subportal);
     398                 :             :     }
     399         [ +  + ]:       20720 :     if (IsA(stmt, ExecuteStmt))
     400                 :             :     {
     401                 :        8325 :         ExecuteStmt *estmt = (ExecuteStmt *) stmt;
     402                 :             :         PreparedStatement *entry;
     403                 :             : 
     404                 :        8325 :         entry = FetchPreparedStatement(estmt->name, true);
     405                 :        8325 :         return FetchPreparedStatementTargetList(entry);
     406                 :             :     }
     407                 :       12395 :     return NIL;
     408                 :             : }
     409                 :             : 
     410                 :             : /*
     411                 :             :  * PortalStart
     412                 :             :  *      Prepare a portal for execution.
     413                 :             :  *
     414                 :             :  * Caller must already have created the portal, done PortalDefineQuery(),
     415                 :             :  * and adjusted portal options if needed.
     416                 :             :  *
     417                 :             :  * If parameters are needed by the query, they must be passed in "params"
     418                 :             :  * (caller is responsible for giving them appropriate lifetime).
     419                 :             :  *
     420                 :             :  * The caller can also provide an initial set of "eflags" to be passed to
     421                 :             :  * ExecutorStart (but note these can be modified internally, and they are
     422                 :             :  * currently only honored for PORTAL_ONE_SELECT portals).  Most callers
     423                 :             :  * should simply pass zero.
     424                 :             :  *
     425                 :             :  * The caller can optionally pass a snapshot to be used; pass InvalidSnapshot
     426                 :             :  * for the normal behavior of setting a new snapshot.  This parameter is
     427                 :             :  * presently ignored for non-PORTAL_ONE_SELECT portals (it's only intended
     428                 :             :  * to be used for cursors).
     429                 :             :  *
     430                 :             :  * On return, portal is ready to accept PortalRun() calls, and the result
     431                 :             :  * tupdesc (if any) is known.
     432                 :             :  */
     433                 :             : void
     434                 :      469834 : PortalStart(Portal portal, ParamListInfo params,
     435                 :             :             int eflags, Snapshot snapshot)
     436                 :             : {
     437                 :             :     Portal      saveActivePortal;
     438                 :             :     ResourceOwner saveResourceOwner;
     439                 :             :     MemoryContext savePortalContext;
     440                 :             :     MemoryContext oldContext;
     441                 :             :     QueryDesc  *queryDesc;
     442                 :             :     int         myeflags;
     443                 :             : 
     444                 :             :     Assert(PortalIsValid(portal));
     445                 :             :     Assert(portal->status == PORTAL_DEFINED);
     446                 :             : 
     447                 :             :     /*
     448                 :             :      * Set up global portal context pointers.
     449                 :             :      */
     450                 :      469834 :     saveActivePortal = ActivePortal;
     451                 :      469834 :     saveResourceOwner = CurrentResourceOwner;
     452                 :      469834 :     savePortalContext = PortalContext;
     453         [ +  + ]:      469834 :     PG_TRY();
     454                 :             :     {
     455                 :      469834 :         ActivePortal = portal;
     456         [ +  - ]:      469834 :         if (portal->resowner)
     457                 :      469834 :             CurrentResourceOwner = portal->resowner;
     458                 :      469834 :         PortalContext = portal->portalContext;
     459                 :             : 
     460                 :      469834 :         oldContext = MemoryContextSwitchTo(PortalContext);
     461                 :             : 
     462                 :             :         /* Must remember portal param list, if any */
     463                 :      469834 :         portal->portalParams = params;
     464                 :             : 
     465                 :             :         /*
     466                 :             :          * Determine the portal execution strategy
     467                 :             :          */
     468                 :      469834 :         portal->strategy = ChoosePortalStrategy(portal->stmts);
     469                 :             : 
     470                 :             :         /*
     471                 :             :          * Fire her up according to the strategy
     472                 :             :          */
     473   [ +  +  +  +  :      469834 :         switch (portal->strategy)
                      - ]
     474                 :             :         {
     475                 :      185170 :             case PORTAL_ONE_SELECT:
     476                 :             : 
     477                 :             :                 /* Must set snapshot before starting executor. */
     478         [ +  + ]:      185170 :                 if (snapshot)
     479                 :       13882 :                     PushActiveSnapshot(snapshot);
     480                 :             :                 else
     481                 :      171288 :                     PushActiveSnapshot(GetTransactionSnapshot());
     482                 :             : 
     483                 :             :                 /*
     484                 :             :                  * We could remember the snapshot in portal->portalSnapshot,
     485                 :             :                  * but presently there seems no need to, as this code path
     486                 :             :                  * cannot be used for non-atomic execution.  Hence there can't
     487                 :             :                  * be any commit/abort that might destroy the snapshot.  Since
     488                 :             :                  * we don't do that, there's also no need to force a
     489                 :             :                  * non-default nesting level for the snapshot.
     490                 :             :                  */
     491                 :             : 
     492                 :             :                 /*
     493                 :             :                  * Create QueryDesc in portal's context; for the moment, set
     494                 :             :                  * the destination to DestNone.
     495                 :             :                  */
     496                 :      185170 :                 queryDesc = CreateQueryDesc(linitial_node(PlannedStmt, portal->stmts),
     497                 :             :                                             portal->sourceText,
     498                 :             :                                             GetActiveSnapshot(),
     499                 :             :                                             InvalidSnapshot,
     500                 :             :                                             None_Receiver,
     501                 :             :                                             params,
     502                 :             :                                             portal->queryEnv,
     503                 :             :                                             0);
     504                 :             : 
     505                 :             :                 /*
     506                 :             :                  * If it's a scrollable cursor, executor needs to support
     507                 :             :                  * REWIND and backwards scan, as well as whatever the caller
     508                 :             :                  * might've asked for.
     509                 :             :                  */
     510         [ +  + ]:      185170 :                 if (portal->cursorOptions & CURSOR_OPT_SCROLL)
     511                 :        2442 :                     myeflags = eflags | EXEC_FLAG_REWIND | EXEC_FLAG_BACKWARD;
     512                 :             :                 else
     513                 :      182728 :                     myeflags = eflags;
     514                 :             : 
     515                 :             :                 /*
     516                 :             :                  * Call ExecutorStart to prepare the plan for execution
     517                 :             :                  */
     518                 :      185170 :                 ExecutorStart(queryDesc, myeflags);
     519                 :             : 
     520                 :             :                 /*
     521                 :             :                  * This tells PortalCleanup to shut down the executor
     522                 :             :                  */
     523                 :      184757 :                 portal->queryDesc = queryDesc;
     524                 :             : 
     525                 :             :                 /*
     526                 :             :                  * Remember tuple descriptor (computed by ExecutorStart)
     527                 :             :                  */
     528                 :      184757 :                 portal->tupDesc = queryDesc->tupDesc;
     529                 :             : 
     530                 :             :                 /*
     531                 :             :                  * Reset cursor position data to "start of query"
     532                 :             :                  */
     533                 :      184757 :                 portal->atStart = true;
     534                 :      184757 :                 portal->atEnd = false;   /* allow fetches */
     535                 :      184757 :                 portal->portalPos = 0;
     536                 :             : 
     537                 :      184757 :                 PopActiveSnapshot();
     538                 :      184757 :                 break;
     539                 :             : 
     540                 :        2171 :             case PORTAL_ONE_RETURNING:
     541                 :             :             case PORTAL_ONE_MOD_WITH:
     542                 :             : 
     543                 :             :                 /*
     544                 :             :                  * We don't start the executor until we are told to run the
     545                 :             :                  * portal.  We do need to set up the result tupdesc.
     546                 :             :                  */
     547                 :             :                 {
     548                 :             :                     PlannedStmt *pstmt;
     549                 :             : 
     550                 :        2171 :                     pstmt = PortalGetPrimaryStmt(portal);
     551                 :        2171 :                     portal->tupDesc =
     552                 :        2171 :                         ExecCleanTypeFromTL(pstmt->planTree->targetlist);
     553                 :             :                 }
     554                 :             : 
     555                 :             :                 /*
     556                 :             :                  * Reset cursor position data to "start of query"
     557                 :             :                  */
     558                 :        2171 :                 portal->atStart = true;
     559                 :        2171 :                 portal->atEnd = false;   /* allow fetches */
     560                 :        2171 :                 portal->portalPos = 0;
     561                 :        2171 :                 break;
     562                 :             : 
     563                 :       29616 :             case PORTAL_UTIL_SELECT:
     564                 :             : 
     565                 :             :                 /*
     566                 :             :                  * We don't set snapshot here, because PortalRunUtility will
     567                 :             :                  * take care of it if needed.
     568                 :             :                  */
     569                 :             :                 {
     570                 :       29616 :                     PlannedStmt *pstmt = PortalGetPrimaryStmt(portal);
     571                 :             : 
     572                 :             :                     Assert(pstmt->commandType == CMD_UTILITY);
     573                 :       29616 :                     portal->tupDesc = UtilityTupleDescriptor(pstmt->utilityStmt);
     574                 :             :                 }
     575                 :             : 
     576                 :             :                 /*
     577                 :             :                  * Reset cursor position data to "start of query"
     578                 :             :                  */
     579                 :       29598 :                 portal->atStart = true;
     580                 :       29598 :                 portal->atEnd = false;   /* allow fetches */
     581                 :       29598 :                 portal->portalPos = 0;
     582                 :       29598 :                 break;
     583                 :             : 
     584                 :      252877 :             case PORTAL_MULTI_QUERY:
     585                 :             :                 /* Need do nothing now */
     586                 :      252877 :                 portal->tupDesc = NULL;
     587                 :      252877 :                 break;
     588                 :             :         }
     589                 :             :     }
     590                 :         431 :     PG_CATCH();
     591                 :             :     {
     592                 :             :         /* Uncaught error while executing portal: mark it dead */
     593                 :         431 :         MarkPortalFailed(portal);
     594                 :             : 
     595                 :             :         /* Restore global vars and propagate error */
     596                 :         431 :         ActivePortal = saveActivePortal;
     597                 :         431 :         CurrentResourceOwner = saveResourceOwner;
     598                 :         431 :         PortalContext = savePortalContext;
     599                 :             : 
     600                 :         431 :         PG_RE_THROW();
     601                 :             :     }
     602         [ -  + ]:      469403 :     PG_END_TRY();
     603                 :             : 
     604                 :      469403 :     MemoryContextSwitchTo(oldContext);
     605                 :             : 
     606                 :      469403 :     ActivePortal = saveActivePortal;
     607                 :      469403 :     CurrentResourceOwner = saveResourceOwner;
     608                 :      469403 :     PortalContext = savePortalContext;
     609                 :             : 
     610                 :      469403 :     portal->status = PORTAL_READY;
     611                 :      469403 : }
     612                 :             : 
     613                 :             : /*
     614                 :             :  * PortalSetResultFormat
     615                 :             :  *      Select the format codes for a portal's output.
     616                 :             :  *
     617                 :             :  * This must be run after PortalStart for a portal that will be read by
     618                 :             :  * a DestRemote or DestRemoteExecute destination.  It is not presently needed
     619                 :             :  * for other destination types.
     620                 :             :  *
     621                 :             :  * formats[] is the client format request, as per Bind message conventions.
     622                 :             :  */
     623                 :             : void
     624                 :      449996 : PortalSetResultFormat(Portal portal, int nFormats, int16 *formats)
     625                 :             : {
     626                 :             :     int         natts;
     627                 :             :     int         i;
     628                 :             : 
     629                 :             :     /* Do nothing if portal won't return tuples */
     630         [ +  + ]:      449996 :     if (portal->tupDesc == NULL)
     631                 :      252806 :         return;
     632                 :      197190 :     natts = portal->tupDesc->natts;
     633                 :      197190 :     portal->formats = (int16 *)
     634                 :      197190 :         MemoryContextAlloc(portal->portalContext,
     635                 :             :                            natts * sizeof(int16));
     636         [ -  + ]:      197190 :     if (nFormats > 1)
     637                 :             :     {
     638                 :             :         /* format specified for each column */
     639         [ #  # ]:           0 :         if (nFormats != natts)
     640         [ #  # ]:           0 :             ereport(ERROR,
     641                 :             :                     (errcode(ERRCODE_PROTOCOL_VIOLATION),
     642                 :             :                      errmsg("bind message has %d result formats but query has %d columns",
     643                 :             :                             nFormats, natts)));
     644                 :           0 :         memcpy(portal->formats, formats, natts * sizeof(int16));
     645                 :             :     }
     646         [ +  - ]:      197190 :     else if (nFormats > 0)
     647                 :             :     {
     648                 :             :         /* single format specified, use for all columns */
     649                 :      197190 :         int16       format1 = formats[0];
     650                 :             : 
     651         [ +  + ]:      797788 :         for (i = 0; i < natts; i++)
     652                 :      600598 :             portal->formats[i] = format1;
     653                 :             :     }
     654                 :             :     else
     655                 :             :     {
     656                 :             :         /* use default format for all columns */
     657         [ #  # ]:           0 :         for (i = 0; i < natts; i++)
     658                 :           0 :             portal->formats[i] = 0;
     659                 :             :     }
     660                 :             : }
     661                 :             : 
     662                 :             : /*
     663                 :             :  * PortalRun
     664                 :             :  *      Run a portal's query or queries.
     665                 :             :  *
     666                 :             :  * count <= 0 is interpreted as a no-op: the destination gets started up
     667                 :             :  * and shut down, but nothing else happens.  Also, count == FETCH_ALL is
     668                 :             :  * interpreted as "all rows".  Note that count is ignored in multi-query
     669                 :             :  * situations, where we always run the portal to completion.
     670                 :             :  *
     671                 :             :  * isTopLevel: true if query is being executed at backend "top level"
     672                 :             :  * (that is, directly from a client command message)
     673                 :             :  *
     674                 :             :  * dest: where to send output of primary (canSetTag) query
     675                 :             :  *
     676                 :             :  * altdest: where to send output of non-primary queries
     677                 :             :  *
     678                 :             :  * qc: where to store command completion status data.
     679                 :             :  *      May be NULL if caller doesn't want status data.
     680                 :             :  *
     681                 :             :  * Returns true if the portal's execution is complete, false if it was
     682                 :             :  * suspended due to exhaustion of the count parameter.
     683                 :             :  */
     684                 :             : bool
     685                 :      458423 : PortalRun(Portal portal, long count, bool isTopLevel,
     686                 :             :           DestReceiver *dest, DestReceiver *altdest,
     687                 :             :           QueryCompletion *qc)
     688                 :             : {
     689                 :             :     bool        result;
     690                 :             :     uint64      nprocessed;
     691                 :             :     ResourceOwner saveTopTransactionResourceOwner;
     692                 :             :     MemoryContext saveTopTransactionContext;
     693                 :             :     Portal      saveActivePortal;
     694                 :             :     ResourceOwner saveResourceOwner;
     695                 :             :     MemoryContext savePortalContext;
     696                 :             :     MemoryContext saveMemoryContext;
     697                 :             : 
     698                 :             :     Assert(PortalIsValid(portal));
     699                 :             : 
     700                 :             :     TRACE_POSTGRESQL_QUERY_EXECUTE_START();
     701                 :             : 
     702                 :             :     /* Initialize empty completion data */
     703         [ +  - ]:      458423 :     if (qc)
     704                 :      458423 :         InitializeQueryCompletion(qc);
     705                 :             : 
     706   [ -  +  -  - ]:      458423 :     if (log_executor_stats && portal->strategy != PORTAL_MULTI_QUERY)
     707                 :             :     {
     708         [ #  # ]:           0 :         elog(DEBUG3, "PortalRun");
     709                 :             :         /* PORTAL_MULTI_QUERY logs its own stats per query */
     710                 :           0 :         ResetUsage();
     711                 :             :     }
     712                 :             : 
     713                 :             :     /*
     714                 :             :      * Check for improper portal use, and mark portal active.
     715                 :             :      */
     716                 :      458423 :     MarkPortalActive(portal);
     717                 :             : 
     718                 :             :     /*
     719                 :             :      * Set up global portal context pointers.
     720                 :             :      *
     721                 :             :      * We have to play a special game here to support utility commands like
     722                 :             :      * VACUUM and CLUSTER, which internally start and commit transactions.
     723                 :             :      * When we are called to execute such a command, CurrentResourceOwner will
     724                 :             :      * be pointing to the TopTransactionResourceOwner --- which will be
     725                 :             :      * destroyed and replaced in the course of the internal commit and
     726                 :             :      * restart.  So we need to be prepared to restore it as pointing to the
     727                 :             :      * exit-time TopTransactionResourceOwner.  (Ain't that ugly?  This idea of
     728                 :             :      * internally starting whole new transactions is not good.)
     729                 :             :      * CurrentMemoryContext has a similar problem, but the other pointers we
     730                 :             :      * save here will be NULL or pointing to longer-lived objects.
     731                 :             :      */
     732                 :      458423 :     saveTopTransactionResourceOwner = TopTransactionResourceOwner;
     733                 :      458423 :     saveTopTransactionContext = TopTransactionContext;
     734                 :      458423 :     saveActivePortal = ActivePortal;
     735                 :      458423 :     saveResourceOwner = CurrentResourceOwner;
     736                 :      458423 :     savePortalContext = PortalContext;
     737                 :      458423 :     saveMemoryContext = CurrentMemoryContext;
     738         [ +  + ]:      458423 :     PG_TRY();
     739                 :             :     {
     740                 :      458423 :         ActivePortal = portal;
     741         [ +  - ]:      458423 :         if (portal->resowner)
     742                 :      458423 :             CurrentResourceOwner = portal->resowner;
     743                 :      458423 :         PortalContext = portal->portalContext;
     744                 :             : 
     745                 :      458423 :         MemoryContextSwitchTo(PortalContext);
     746                 :             : 
     747      [ +  +  - ]:      458423 :         switch (portal->strategy)
     748                 :             :         {
     749                 :      205546 :             case PORTAL_ONE_SELECT:
     750                 :             :             case PORTAL_ONE_RETURNING:
     751                 :             :             case PORTAL_ONE_MOD_WITH:
     752                 :             :             case PORTAL_UTIL_SELECT:
     753                 :             : 
     754                 :             :                 /*
     755                 :             :                  * If we have not yet run the command, do so, storing its
     756                 :             :                  * results in the portal's tuplestore.  But we don't do that
     757                 :             :                  * for the PORTAL_ONE_SELECT case.
     758                 :             :                  */
     759   [ +  +  +  - ]:      205546 :                 if (portal->strategy != PORTAL_ONE_SELECT && !portal->holdStore)
     760                 :       26329 :                     FillPortalStore(portal, isTopLevel);
     761                 :             : 
     762                 :             :                 /*
     763                 :             :                  * Now fetch desired portion of results.
     764                 :             :                  */
     765                 :      205207 :                 nprocessed = PortalRunSelect(portal, true, count, dest);
     766                 :             : 
     767                 :             :                 /*
     768                 :             :                  * If the portal result contains a command tag and the caller
     769                 :             :                  * gave us a pointer to store it, copy it and update the
     770                 :             :                  * rowcount.
     771                 :             :                  */
     772   [ +  -  +  - ]:      200110 :                 if (qc && portal->qc.commandTag != CMDTAG_UNKNOWN)
     773                 :             :                 {
     774                 :      200110 :                     CopyQueryCompletion(qc, &portal->qc);
     775                 :      200110 :                     qc->nprocessed = nprocessed;
     776                 :             :                 }
     777                 :             : 
     778                 :             :                 /* Mark portal not active */
     779                 :      200110 :                 portal->status = PORTAL_READY;
     780                 :             : 
     781                 :             :                 /*
     782                 :             :                  * Since it's a forward fetch, say DONE iff atEnd is now true.
     783                 :             :                  */
     784                 :      200110 :                 result = portal->atEnd;
     785                 :      200110 :                 break;
     786                 :             : 
     787                 :      252877 :             case PORTAL_MULTI_QUERY:
     788                 :      252877 :                 PortalRunMulti(portal, isTopLevel, false,
     789                 :             :                                dest, altdest, qc);
     790                 :             : 
     791                 :             :                 /* Prevent portal's commands from being re-executed */
     792                 :      238210 :                 MarkPortalDone(portal);
     793                 :             : 
     794                 :             :                 /* Always complete at end of RunMulti */
     795                 :      238210 :                 result = true;
     796                 :      238210 :                 break;
     797                 :             : 
     798                 :           0 :             default:
     799         [ #  # ]:           0 :                 elog(ERROR, "unrecognized portal strategy: %d",
     800                 :             :                      (int) portal->strategy);
     801                 :             :                 result = false; /* keep compiler quiet */
     802                 :             :                 break;
     803                 :             :         }
     804                 :             :     }
     805                 :       20098 :     PG_CATCH();
     806                 :             :     {
     807                 :             :         /* Uncaught error while executing portal: mark it dead */
     808                 :       20098 :         MarkPortalFailed(portal);
     809                 :             : 
     810                 :             :         /* Restore global vars and propagate error */
     811         [ +  + ]:       20098 :         if (saveMemoryContext == saveTopTransactionContext)
     812                 :       19837 :             MemoryContextSwitchTo(TopTransactionContext);
     813                 :             :         else
     814                 :         261 :             MemoryContextSwitchTo(saveMemoryContext);
     815                 :       20098 :         ActivePortal = saveActivePortal;
     816         [ +  + ]:       20098 :         if (saveResourceOwner == saveTopTransactionResourceOwner)
     817                 :       19890 :             CurrentResourceOwner = TopTransactionResourceOwner;
     818                 :             :         else
     819                 :         208 :             CurrentResourceOwner = saveResourceOwner;
     820                 :       20098 :         PortalContext = savePortalContext;
     821                 :             : 
     822                 :       20098 :         PG_RE_THROW();
     823                 :             :     }
     824         [ -  + ]:      438320 :     PG_END_TRY();
     825                 :             : 
     826         [ +  + ]:      438320 :     if (saveMemoryContext == saveTopTransactionContext)
     827                 :      414619 :         MemoryContextSwitchTo(TopTransactionContext);
     828                 :             :     else
     829                 :       23701 :         MemoryContextSwitchTo(saveMemoryContext);
     830                 :      438320 :     ActivePortal = saveActivePortal;
     831         [ +  + ]:      438320 :     if (saveResourceOwner == saveTopTransactionResourceOwner)
     832                 :      425948 :         CurrentResourceOwner = TopTransactionResourceOwner;
     833                 :             :     else
     834                 :       12372 :         CurrentResourceOwner = saveResourceOwner;
     835                 :      438320 :     PortalContext = savePortalContext;
     836                 :             : 
     837   [ -  +  -  - ]:      438320 :     if (log_executor_stats && portal->strategy != PORTAL_MULTI_QUERY)
     838                 :           0 :         ShowUsage("EXECUTOR STATISTICS");
     839                 :             : 
     840                 :             :     TRACE_POSTGRESQL_QUERY_EXECUTE_DONE();
     841                 :             : 
     842                 :      438320 :     return result;
     843                 :             : }
     844                 :             : 
     845                 :             : /*
     846                 :             :  * PortalRunSelect
     847                 :             :  *      Execute a portal's query in PORTAL_ONE_SELECT mode, and also
     848                 :             :  *      when fetching from a completed holdStore in PORTAL_ONE_RETURNING,
     849                 :             :  *      PORTAL_ONE_MOD_WITH, and PORTAL_UTIL_SELECT cases.
     850                 :             :  *
     851                 :             :  * This handles simple N-rows-forward-or-backward cases.  For more complex
     852                 :             :  * nonsequential access to a portal, see PortalRunFetch.
     853                 :             :  *
     854                 :             :  * count <= 0 is interpreted as a no-op: the destination gets started up
     855                 :             :  * and shut down, but nothing else happens.  Also, count == FETCH_ALL is
     856                 :             :  * interpreted as "all rows".  (cf FetchStmt.howMany)
     857                 :             :  *
     858                 :             :  * Caller must already have validated the Portal and done appropriate
     859                 :             :  * setup (cf. PortalRun).
     860                 :             :  *
     861                 :             :  * Returns number of rows processed (suitable for use in result tag)
     862                 :             :  */
     863                 :             : static uint64
     864                 :      239516 : PortalRunSelect(Portal portal,
     865                 :             :                 bool forward,
     866                 :             :                 long count,
     867                 :             :                 DestReceiver *dest)
     868                 :             : {
     869                 :             :     QueryDesc  *queryDesc;
     870                 :             :     ScanDirection direction;
     871                 :             :     uint64      nprocessed;
     872                 :             : 
     873                 :             :     /*
     874                 :             :      * NB: queryDesc will be NULL if we are fetching from a held cursor or a
     875                 :             :      * completed utility query; can't use it in that path.
     876                 :             :      */
     877                 :      239516 :     queryDesc = portal->queryDesc;
     878                 :             : 
     879                 :             :     /* Caller messed up if we have neither a ready query nor held data. */
     880                 :             :     Assert(queryDesc || portal->holdStore);
     881                 :             : 
     882                 :             :     /*
     883                 :             :      * Force the queryDesc destination to the right thing.  This supports
     884                 :             :      * MOVE, for example, which will pass in dest = DestNone.  This is okay to
     885                 :             :      * change as long as we do it on every fetch.  (The Executor must not
     886                 :             :      * assume that dest never changes.)
     887                 :             :      */
     888         [ +  + ]:      239516 :     if (queryDesc)
     889                 :      192062 :         queryDesc->dest = dest;
     890                 :             : 
     891                 :             :     /*
     892                 :             :      * Determine which direction to go in, and check to see if we're already
     893                 :             :      * at the end of the available tuples in that direction.  If so, set the
     894                 :             :      * direction to NoMovement to avoid trying to fetch any tuples.  (This
     895                 :             :      * check exists because not all plan node types are robust about being
     896                 :             :      * called again if they've already returned NULL once.)  Then call the
     897                 :             :      * executor (we must not skip this, because the destination needs to see a
     898                 :             :      * setup and shutdown even if no tuples are available).  Finally, update
     899                 :             :      * the portal position state depending on the number of tuples that were
     900                 :             :      * retrieved.
     901                 :             :      */
     902         [ +  + ]:      239516 :     if (forward)
     903                 :             :     {
     904   [ +  +  +  + ]:      239092 :         if (portal->atEnd || count <= 0)
     905                 :             :         {
     906                 :        2504 :             direction = NoMovementScanDirection;
     907                 :        2504 :             count = 0;          /* don't pass negative count to executor */
     908                 :             :         }
     909                 :             :         else
     910                 :      236588 :             direction = ForwardScanDirection;
     911                 :             : 
     912                 :             :         /* In the executor, zero count processes all rows */
     913         [ +  + ]:      239092 :         if (count == FETCH_ALL)
     914                 :      205426 :             count = 0;
     915                 :             : 
     916         [ +  + ]:      239092 :         if (portal->holdStore)
     917                 :       47442 :             nprocessed = RunFromStore(portal, direction, (uint64) count, dest);
     918                 :             :         else
     919                 :             :         {
     920                 :      191650 :             PushActiveSnapshot(queryDesc->snapshot);
     921                 :      191650 :             ExecutorRun(queryDesc, direction, (uint64) count);
     922                 :      186525 :             nprocessed = queryDesc->estate->es_processed;
     923                 :      186525 :             PopActiveSnapshot();
     924                 :             :         }
     925                 :             : 
     926         [ +  + ]:      233967 :         if (!ScanDirectionIsNoMovement(direction))
     927                 :             :         {
     928         [ +  + ]:      231463 :             if (nprocessed > 0)
     929                 :      193361 :                 portal->atStart = false; /* OK to go backward now */
     930   [ +  +  +  + ]:      231463 :             if (count == 0 || nprocessed < (uint64) count)
     931                 :      209599 :                 portal->atEnd = true;    /* we retrieved 'em all */
     932                 :      231463 :             portal->portalPos += nprocessed;
     933                 :             :         }
     934                 :             :     }
     935                 :             :     else
     936                 :             :     {
     937         [ +  + ]:         424 :         if (portal->cursorOptions & CURSOR_OPT_NO_SCROLL)
     938         [ +  - ]:          16 :             ereport(ERROR,
     939                 :             :                     (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
     940                 :             :                      errmsg("cursor can only scan forward"),
     941                 :             :                      errhint("Declare it with SCROLL option to enable backward scan.")));
     942                 :             : 
     943   [ +  +  -  + ]:         408 :         if (portal->atStart || count <= 0)
     944                 :             :         {
     945                 :          48 :             direction = NoMovementScanDirection;
     946                 :          48 :             count = 0;          /* don't pass negative count to executor */
     947                 :             :         }
     948                 :             :         else
     949                 :         360 :             direction = BackwardScanDirection;
     950                 :             : 
     951                 :             :         /* In the executor, zero count processes all rows */
     952         [ +  + ]:         408 :         if (count == FETCH_ALL)
     953                 :          41 :             count = 0;
     954                 :             : 
     955         [ +  + ]:         408 :         if (portal->holdStore)
     956                 :           8 :             nprocessed = RunFromStore(portal, direction, (uint64) count, dest);
     957                 :             :         else
     958                 :             :         {
     959                 :         400 :             PushActiveSnapshot(queryDesc->snapshot);
     960                 :         400 :             ExecutorRun(queryDesc, direction, (uint64) count);
     961                 :         400 :             nprocessed = queryDesc->estate->es_processed;
     962                 :         400 :             PopActiveSnapshot();
     963                 :             :         }
     964                 :             : 
     965         [ +  + ]:         408 :         if (!ScanDirectionIsNoMovement(direction))
     966                 :             :         {
     967   [ +  +  +  + ]:         360 :             if (nprocessed > 0 && portal->atEnd)
     968                 :             :             {
     969                 :         110 :                 portal->atEnd = false;   /* OK to go forward now */
     970                 :         110 :                 portal->portalPos++; /* adjust for endpoint case */
     971                 :             :             }
     972   [ +  +  +  + ]:         360 :             if (count == 0 || nprocessed < (uint64) count)
     973                 :             :             {
     974                 :         125 :                 portal->atStart = true; /* we retrieved 'em all */
     975                 :         125 :                 portal->portalPos = 0;
     976                 :             :             }
     977                 :             :             else
     978                 :             :             {
     979                 :         235 :                 portal->portalPos -= nprocessed;
     980                 :             :             }
     981                 :             :         }
     982                 :             :     }
     983                 :             : 
     984                 :      234375 :     return nprocessed;
     985                 :             : }
     986                 :             : 
     987                 :             : /*
     988                 :             :  * FillPortalStore
     989                 :             :  *      Run the query and load result tuples into the portal's tuple store.
     990                 :             :  *
     991                 :             :  * This is used for PORTAL_ONE_RETURNING, PORTAL_ONE_MOD_WITH, and
     992                 :             :  * PORTAL_UTIL_SELECT cases only.
     993                 :             :  */
     994                 :             : static void
     995                 :       31769 : FillPortalStore(Portal portal, bool isTopLevel)
     996                 :             : {
     997                 :             :     DestReceiver *treceiver;
     998                 :             :     QueryCompletion qc;
     999                 :             : 
    1000                 :       31769 :     InitializeQueryCompletion(&qc);
    1001                 :       31769 :     PortalCreateHoldStore(portal);
    1002                 :       31769 :     treceiver = CreateDestReceiver(DestTuplestore);
    1003                 :       31769 :     SetTuplestoreDestReceiverParams(treceiver,
    1004                 :             :                                     portal->holdStore,
    1005                 :             :                                     portal->holdContext,
    1006                 :             :                                     false,
    1007                 :             :                                     portal->tupDesc,
    1008                 :             :                                     gettext_noop("query result type does not match portal result type"));
    1009                 :             : 
    1010      [ +  +  - ]:       31769 :     switch (portal->strategy)
    1011                 :             :     {
    1012                 :        2171 :         case PORTAL_ONE_RETURNING:
    1013                 :             :         case PORTAL_ONE_MOD_WITH:
    1014                 :             : 
    1015                 :             :             /*
    1016                 :             :              * Run the portal to completion just as for the default
    1017                 :             :              * PORTAL_MULTI_QUERY case, but send the primary query's output to
    1018                 :             :              * the tuplestore.  Auxiliary query outputs are discarded. Set the
    1019                 :             :              * portal's holdSnapshot to the snapshot used (or a copy of it).
    1020                 :             :              */
    1021                 :        2171 :             PortalRunMulti(portal, isTopLevel, true,
    1022                 :             :                            treceiver, None_Receiver, &qc);
    1023                 :        2032 :             break;
    1024                 :             : 
    1025                 :       29598 :         case PORTAL_UTIL_SELECT:
    1026                 :       29598 :             PortalRunUtility(portal, linitial_node(PlannedStmt, portal->stmts),
    1027                 :             :                              isTopLevel, true, treceiver, &qc);
    1028                 :       29394 :             break;
    1029                 :             : 
    1030                 :           0 :         default:
    1031         [ #  # ]:           0 :             elog(ERROR, "unsupported portal strategy: %d",
    1032                 :             :                  (int) portal->strategy);
    1033                 :             :             break;
    1034                 :             :     }
    1035                 :             : 
    1036                 :             :     /* Override portal completion data with actual command results */
    1037         [ +  + ]:       31426 :     if (qc.commandTag != CMDTAG_UNKNOWN)
    1038                 :       13600 :         CopyQueryCompletion(&portal->qc, &qc);
    1039                 :             : 
    1040                 :       31426 :     treceiver->rDestroy(treceiver);
    1041                 :       31426 : }
    1042                 :             : 
    1043                 :             : /*
    1044                 :             :  * RunFromStore
    1045                 :             :  *      Fetch tuples from the portal's tuple store.
    1046                 :             :  *
    1047                 :             :  * Calling conventions are similar to ExecutorRun, except that we
    1048                 :             :  * do not depend on having a queryDesc or estate.  Therefore we return the
    1049                 :             :  * number of tuples processed as the result, not in estate->es_processed.
    1050                 :             :  *
    1051                 :             :  * One difference from ExecutorRun is that the destination receiver functions
    1052                 :             :  * are run in the caller's memory context (since we have no estate).  Watch
    1053                 :             :  * out for memory leaks.
    1054                 :             :  */
    1055                 :             : static uint64
    1056                 :       47450 : RunFromStore(Portal portal, ScanDirection direction, uint64 count,
    1057                 :             :              DestReceiver *dest)
    1058                 :             : {
    1059                 :       47450 :     uint64      current_tuple_count = 0;
    1060                 :             :     TupleTableSlot *slot;
    1061                 :             : 
    1062                 :       47450 :     slot = MakeSingleTupleTableSlot(portal->tupDesc, &TTSOpsMinimalTuple);
    1063                 :             : 
    1064                 :       47450 :     dest->rStartup(dest, CMD_SELECT, portal->tupDesc);
    1065                 :             : 
    1066         [ +  + ]:       47450 :     if (ScanDirectionIsNoMovement(direction))
    1067                 :             :     {
    1068                 :             :         /* do nothing except start/stop the destination */
    1069                 :             :     }
    1070                 :             :     else
    1071                 :             :     {
    1072                 :       45692 :         bool        forward = ScanDirectionIsForward(direction);
    1073                 :             : 
    1074                 :             :         for (;;)
    1075                 :      266010 :         {
    1076                 :             :             MemoryContext oldcontext;
    1077                 :             :             bool        ok;
    1078                 :             : 
    1079                 :      311702 :             oldcontext = MemoryContextSwitchTo(portal->holdContext);
    1080                 :             : 
    1081                 :      311702 :             ok = tuplestore_gettupleslot(portal->holdStore, forward, false,
    1082                 :             :                                          slot);
    1083                 :             : 
    1084                 :      311702 :             MemoryContextSwitchTo(oldcontext);
    1085                 :             : 
    1086         [ +  + ]:      311702 :             if (!ok)
    1087                 :       31458 :                 break;
    1088                 :             : 
    1089                 :             :             /*
    1090                 :             :              * If we are not able to send the tuple, we assume the destination
    1091                 :             :              * has closed and no more tuples can be sent. If that's the case,
    1092                 :             :              * end the loop.
    1093                 :             :              */
    1094         [ -  + ]:      280244 :             if (!dest->receiveSlot(slot, dest))
    1095                 :           0 :                 break;
    1096                 :             : 
    1097                 :      280244 :             ExecClearTuple(slot);
    1098                 :             : 
    1099                 :             :             /*
    1100                 :             :              * check our tuple count.. if we've processed the proper number
    1101                 :             :              * then quit, else loop again and process more tuples. Zero count
    1102                 :             :              * means no limit.
    1103                 :             :              */
    1104                 :      280244 :             current_tuple_count++;
    1105   [ +  +  +  + ]:      280244 :             if (count && count == current_tuple_count)
    1106                 :       14234 :                 break;
    1107                 :             :         }
    1108                 :             :     }
    1109                 :             : 
    1110                 :       47450 :     dest->rShutdown(dest);
    1111                 :             : 
    1112                 :       47450 :     ExecDropSingleTupleTableSlot(slot);
    1113                 :             : 
    1114                 :       47450 :     return current_tuple_count;
    1115                 :             : }
    1116                 :             : 
    1117                 :             : /*
    1118                 :             :  * PortalRunUtility
    1119                 :             :  *      Execute a utility statement inside a portal.
    1120                 :             :  */
    1121                 :             : static void
    1122                 :      229338 : PortalRunUtility(Portal portal, PlannedStmt *pstmt,
    1123                 :             :                  bool isTopLevel, bool setHoldSnapshot,
    1124                 :             :                  DestReceiver *dest, QueryCompletion *qc)
    1125                 :             : {
    1126                 :             :     /*
    1127                 :             :      * Set snapshot if utility stmt needs one.
    1128                 :             :      */
    1129         [ +  + ]:      229338 :     if (PlannedStmtRequiresSnapshot(pstmt))
    1130                 :             :     {
    1131                 :      179297 :         Snapshot    snapshot = GetTransactionSnapshot();
    1132                 :             : 
    1133                 :             :         /* If told to, register the snapshot we're using and save in portal */
    1134         [ +  + ]:      179297 :         if (setHoldSnapshot)
    1135                 :             :         {
    1136                 :       25459 :             snapshot = RegisterSnapshot(snapshot);
    1137                 :       25459 :             portal->holdSnapshot = snapshot;
    1138                 :             :         }
    1139                 :             : 
    1140                 :             :         /*
    1141                 :             :          * In any case, make the snapshot active and remember it in portal.
    1142                 :             :          * Because the portal now references the snapshot, we must tell
    1143                 :             :          * snapmgr.c that the snapshot belongs to the portal's transaction
    1144                 :             :          * level, else we risk portalSnapshot becoming a dangling pointer.
    1145                 :             :          */
    1146                 :      179297 :         PushActiveSnapshotWithLevel(snapshot, portal->createLevel);
    1147                 :             :         /* PushActiveSnapshotWithLevel might have copied the snapshot */
    1148                 :      179297 :         portal->portalSnapshot = GetActiveSnapshot();
    1149                 :             :     }
    1150                 :             :     else
    1151                 :       50041 :         portal->portalSnapshot = NULL;
    1152                 :             : 
    1153                 :      229338 :     ProcessUtility(pstmt,
    1154                 :             :                    portal->sourceText,
    1155                 :      229338 :                    (portal->cplan != NULL), /* protect tree if in plancache */
    1156                 :      229338 :                    isTopLevel ? PROCESS_UTILITY_TOPLEVEL : PROCESS_UTILITY_QUERY,
    1157                 :             :                    portal->portalParams,
    1158                 :             :                    portal->queryEnv,
    1159                 :             :                    dest,
    1160                 :             :                    qc);
    1161                 :             : 
    1162                 :             :     /* Some utility statements may change context on us */
    1163                 :      218002 :     MemoryContextSwitchTo(portal->portalContext);
    1164                 :             : 
    1165                 :             :     /*
    1166                 :             :      * Some utility commands (e.g., VACUUM, WAIT FOR) pop the ActiveSnapshot
    1167                 :             :      * stack from under us, so don't complain if it's now empty.  Otherwise,
    1168                 :             :      * our snapshot should be the top one; pop it.  Note that this could be a
    1169                 :             :      * different snapshot from the one we made above; see
    1170                 :             :      * EnsurePortalSnapshotExists.
    1171                 :             :      */
    1172   [ +  +  +  - ]:      218002 :     if (portal->portalSnapshot != NULL && ActiveSnapshotSet())
    1173                 :             :     {
    1174                 :             :         Assert(portal->portalSnapshot == GetActiveSnapshot());
    1175                 :      161818 :         PopActiveSnapshot();
    1176                 :             :     }
    1177                 :      218002 :     portal->portalSnapshot = NULL;
    1178                 :      218002 : }
    1179                 :             : 
    1180                 :             : /*
    1181                 :             :  * PortalRunMulti
    1182                 :             :  *      Execute a portal's queries in the general case (multi queries
    1183                 :             :  *      or non-SELECT-like queries)
    1184                 :             :  */
    1185                 :             : static void
    1186                 :      255048 : PortalRunMulti(Portal portal,
    1187                 :             :                bool isTopLevel, bool setHoldSnapshot,
    1188                 :             :                DestReceiver *dest, DestReceiver *altdest,
    1189                 :             :                QueryCompletion *qc)
    1190                 :             : {
    1191                 :      255048 :     bool        active_snapshot_set = false;
    1192                 :             :     ListCell   *stmtlist_item;
    1193                 :             : 
    1194                 :             :     /*
    1195                 :             :      * If the destination is DestRemoteExecute, change to DestNone.  The
    1196                 :             :      * reason is that the client won't be expecting any tuples, and indeed has
    1197                 :             :      * no way to know what they are, since there is no provision for Describe
    1198                 :             :      * to send a RowDescription message when this portal execution strategy is
    1199                 :             :      * in effect.  This presently will only affect SELECT commands added to
    1200                 :             :      * non-SELECT queries by rewrite rules: such commands will be executed,
    1201                 :             :      * but the results will be discarded unless you use "simple Query"
    1202                 :             :      * protocol.
    1203                 :             :      */
    1204         [ +  + ]:      255048 :     if (dest->mydest == DestRemoteExecute)
    1205                 :        6455 :         dest = None_Receiver;
    1206         [ +  + ]:      255048 :     if (altdest->mydest == DestRemoteExecute)
    1207                 :        6455 :         altdest = None_Receiver;
    1208                 :             : 
    1209                 :             :     /*
    1210                 :             :      * Loop to handle the individual queries generated from a single parsetree
    1211                 :             :      * by analysis and rewrite.
    1212                 :             :      */
    1213   [ +  -  +  +  :      495706 :     foreach(stmtlist_item, portal->stmts)
                   +  + ]
    1214                 :             :     {
    1215                 :      255464 :         PlannedStmt *pstmt = lfirst_node(PlannedStmt, stmtlist_item);
    1216                 :             : 
    1217                 :             :         /*
    1218                 :             :          * If we got a cancel signal in prior command, quit
    1219                 :             :          */
    1220         [ -  + ]:      255464 :         CHECK_FOR_INTERRUPTS();
    1221                 :             : 
    1222         [ +  + ]:      255464 :         if (pstmt->utilityStmt == NULL)
    1223                 :             :         {
    1224                 :             :             /*
    1225                 :             :              * process a plannable query.
    1226                 :             :              */
    1227                 :             :             TRACE_POSTGRESQL_QUERY_EXECUTE_START();
    1228                 :             : 
    1229         [ -  + ]:       55724 :             if (log_executor_stats)
    1230                 :           0 :                 ResetUsage();
    1231                 :             : 
    1232                 :             :             /*
    1233                 :             :              * Must always have a snapshot for plannable queries.  First time
    1234                 :             :              * through, take a new snapshot; for subsequent queries in the
    1235                 :             :              * same portal, just update the snapshot's copy of the command
    1236                 :             :              * counter.
    1237                 :             :              */
    1238         [ +  + ]:       55724 :             if (!active_snapshot_set)
    1239                 :             :             {
    1240                 :       55308 :                 Snapshot    snapshot = GetTransactionSnapshot();
    1241                 :             : 
    1242                 :             :                 /* If told to, register the snapshot and save in portal */
    1243         [ +  + ]:       55308 :                 if (setHoldSnapshot)
    1244                 :             :                 {
    1245                 :        2171 :                     snapshot = RegisterSnapshot(snapshot);
    1246                 :        2171 :                     portal->holdSnapshot = snapshot;
    1247                 :             :                 }
    1248                 :             : 
    1249                 :             :                 /*
    1250                 :             :                  * We can't have the holdSnapshot also be the active one,
    1251                 :             :                  * because UpdateActiveSnapshotCommandId would complain.  So
    1252                 :             :                  * force an extra snapshot copy.  Plain PushActiveSnapshot
    1253                 :             :                  * would have copied the transaction snapshot anyway, so this
    1254                 :             :                  * only adds a copy step when setHoldSnapshot is true.  (It's
    1255                 :             :                  * okay for the command ID of the active snapshot to diverge
    1256                 :             :                  * from what holdSnapshot has.)
    1257                 :             :                  */
    1258                 :       55308 :                 PushCopiedSnapshot(snapshot);
    1259                 :             : 
    1260                 :             :                 /*
    1261                 :             :                  * As for PORTAL_ONE_SELECT portals, it does not seem
    1262                 :             :                  * necessary to maintain portal->portalSnapshot here.
    1263                 :             :                  */
    1264                 :             : 
    1265                 :       55308 :                 active_snapshot_set = true;
    1266                 :             :             }
    1267                 :             :             else
    1268                 :         416 :                 UpdateActiveSnapshotCommandId();
    1269                 :             : 
    1270         [ +  + ]:       55724 :             if (pstmt->canSetTag)
    1271                 :             :             {
    1272                 :             :                 /* statement can set tag string */
    1273                 :       55280 :                 ProcessQuery(pstmt,
    1274                 :             :                              portal->sourceText,
    1275                 :             :                              portal->portalParams,
    1276                 :             :                              portal->queryEnv,
    1277                 :             :                              dest, qc);
    1278                 :             :             }
    1279                 :             :             else
    1280                 :             :             {
    1281                 :             :                 /* stmt added by rewrite cannot set tag */
    1282                 :         444 :                 ProcessQuery(pstmt,
    1283                 :             :                              portal->sourceText,
    1284                 :             :                              portal->portalParams,
    1285                 :             :                              portal->queryEnv,
    1286                 :             :                              altdest, NULL);
    1287                 :             :             }
    1288                 :             : 
    1289         [ -  + ]:       52050 :             if (log_executor_stats)
    1290                 :           0 :                 ShowUsage("EXECUTOR STATISTICS");
    1291                 :             : 
    1292                 :             :             TRACE_POSTGRESQL_QUERY_EXECUTE_DONE();
    1293                 :             :         }
    1294                 :             :         else
    1295                 :             :         {
    1296                 :             :             /*
    1297                 :             :              * process utility functions (create, destroy, etc..)
    1298                 :             :              *
    1299                 :             :              * We must not set a snapshot here for utility commands (if one is
    1300                 :             :              * needed, PortalRunUtility will do it).  If a utility command is
    1301                 :             :              * alone in a portal then everything's fine.  The only case where
    1302                 :             :              * a utility command can be part of a longer list is that rules
    1303                 :             :              * are allowed to include NotifyStmt.  NotifyStmt doesn't care
    1304                 :             :              * whether it has a snapshot or not, so we just leave the current
    1305                 :             :              * snapshot alone if we have one.
    1306                 :             :              */
    1307         [ +  - ]:      199740 :             if (pstmt->canSetTag)
    1308                 :             :             {
    1309                 :             :                 Assert(!active_snapshot_set);
    1310                 :             :                 /* statement can set tag string */
    1311                 :      199740 :                 PortalRunUtility(portal, pstmt, isTopLevel, false,
    1312                 :             :                                  dest, qc);
    1313                 :             :             }
    1314                 :             :             else
    1315                 :             :             {
    1316                 :             :                 Assert(IsA(pstmt->utilityStmt, NotifyStmt));
    1317                 :             :                 /* stmt added by rewrite cannot set tag */
    1318                 :           0 :                 PortalRunUtility(portal, pstmt, isTopLevel, false,
    1319                 :             :                                  altdest, NULL);
    1320                 :             :             }
    1321                 :             :         }
    1322                 :             : 
    1323                 :             :         /*
    1324                 :             :          * Clear subsidiary contexts to recover temporary memory.
    1325                 :             :          */
    1326                 :             :         Assert(portal->portalContext == CurrentMemoryContext);
    1327                 :             : 
    1328                 :      240658 :         MemoryContextDeleteChildren(portal->portalContext);
    1329                 :             : 
    1330                 :             :         /*
    1331                 :             :          * Avoid crashing if portal->stmts has been reset.  This can only
    1332                 :             :          * occur if a CALL or DO utility statement executed an internal
    1333                 :             :          * COMMIT/ROLLBACK (cf PortalReleaseCachedPlan).  The CALL or DO must
    1334                 :             :          * have been the only statement in the portal, so there's nothing left
    1335                 :             :          * for us to do; but we don't want to dereference a now-dangling list
    1336                 :             :          * pointer.
    1337                 :             :          */
    1338         [ -  + ]:      240658 :         if (portal->stmts == NIL)
    1339                 :           0 :             break;
    1340                 :             : 
    1341                 :             :         /*
    1342                 :             :          * Increment command counter between queries, but not after the last
    1343                 :             :          * one.
    1344                 :             :          */
    1345         [ +  + ]:      240658 :         if (lnext(portal->stmts, stmtlist_item) != NULL)
    1346                 :         416 :             CommandCounterIncrement();
    1347                 :             :     }
    1348                 :             : 
    1349                 :             :     /* Pop the snapshot if we pushed one. */
    1350         [ +  + ]:      240242 :     if (active_snapshot_set)
    1351                 :       51634 :         PopActiveSnapshot();
    1352                 :             : 
    1353                 :             :     /*
    1354                 :             :      * If a command tag was requested and we did not fill in a run-time-
    1355                 :             :      * determined tag above, copy the parse-time tag from the Portal.  (There
    1356                 :             :      * might not be any tag there either, in edge cases such as empty prepared
    1357                 :             :      * statements.  That's OK.)
    1358                 :             :      */
    1359         [ +  - ]:      240242 :     if (qc &&
    1360         [ +  + ]:      240242 :         qc->commandTag == CMDTAG_UNKNOWN &&
    1361         [ +  - ]:      181125 :         portal->qc.commandTag != CMDTAG_UNKNOWN)
    1362                 :      181125 :         CopyQueryCompletion(qc, &portal->qc);
    1363                 :      240242 : }
    1364                 :             : 
    1365                 :             : /*
    1366                 :             :  * PortalRunFetch
    1367                 :             :  *      Variant form of PortalRun that supports SQL FETCH directions.
    1368                 :             :  *
    1369                 :             :  * Note: we presently assume that no callers of this want isTopLevel = true.
    1370                 :             :  *
    1371                 :             :  * count <= 0 is interpreted as a no-op: the destination gets started up
    1372                 :             :  * and shut down, but nothing else happens.  Also, count == FETCH_ALL is
    1373                 :             :  * interpreted as "all rows".  (cf FetchStmt.howMany)
    1374                 :             :  *
    1375                 :             :  * Returns number of rows processed (suitable for use in result tag)
    1376                 :             :  */
    1377                 :             : uint64
    1378                 :       34262 : PortalRunFetch(Portal portal,
    1379                 :             :                FetchDirection fdirection,
    1380                 :             :                long count,
    1381                 :             :                DestReceiver *dest)
    1382                 :             : {
    1383                 :             :     uint64      result;
    1384                 :             :     Portal      saveActivePortal;
    1385                 :             :     ResourceOwner saveResourceOwner;
    1386                 :             :     MemoryContext savePortalContext;
    1387                 :             :     MemoryContext oldContext;
    1388                 :             : 
    1389                 :             :     Assert(PortalIsValid(portal));
    1390                 :             : 
    1391                 :             :     /*
    1392                 :             :      * Check for improper portal use, and mark portal active.
    1393                 :             :      */
    1394                 :       34262 :     MarkPortalActive(portal);
    1395                 :             : 
    1396                 :             :     /*
    1397                 :             :      * Set up global portal context pointers.
    1398                 :             :      */
    1399                 :       34250 :     saveActivePortal = ActivePortal;
    1400                 :       34250 :     saveResourceOwner = CurrentResourceOwner;
    1401                 :       34250 :     savePortalContext = PortalContext;
    1402         [ +  + ]:       34250 :     PG_TRY();
    1403                 :             :     {
    1404                 :       34250 :         ActivePortal = portal;
    1405         [ +  + ]:       34250 :         if (portal->resowner)
    1406                 :       34143 :             CurrentResourceOwner = portal->resowner;
    1407                 :       34250 :         PortalContext = portal->portalContext;
    1408                 :             : 
    1409                 :       34250 :         oldContext = MemoryContextSwitchTo(PortalContext);
    1410                 :             : 
    1411      [ +  +  - ]:       34250 :         switch (portal->strategy)
    1412                 :             :         {
    1413                 :       12889 :             case PORTAL_ONE_SELECT:
    1414                 :       12889 :                 result = DoPortalRunFetch(portal, fdirection, count, dest);
    1415                 :       12841 :                 break;
    1416                 :             : 
    1417                 :       21361 :             case PORTAL_ONE_RETURNING:
    1418                 :             :             case PORTAL_ONE_MOD_WITH:
    1419                 :             :             case PORTAL_UTIL_SELECT:
    1420                 :             : 
    1421                 :             :                 /*
    1422                 :             :                  * If we have not yet run the command, do so, storing its
    1423                 :             :                  * results in the portal's tuplestore.
    1424                 :             :                  */
    1425         [ +  + ]:       21361 :                 if (!portal->holdStore)
    1426                 :        5440 :                     FillPortalStore(portal, false /* isTopLevel */ );
    1427                 :             : 
    1428                 :             :                 /*
    1429                 :             :                  * Now fetch desired portion of results.
    1430                 :             :                  */
    1431                 :       21357 :                 result = DoPortalRunFetch(portal, fdirection, count, dest);
    1432                 :       21357 :                 break;
    1433                 :             : 
    1434                 :           0 :             default:
    1435         [ #  # ]:           0 :                 elog(ERROR, "unsupported portal strategy");
    1436                 :             :                 result = 0;     /* keep compiler quiet */
    1437                 :             :                 break;
    1438                 :             :         }
    1439                 :             :     }
    1440                 :          52 :     PG_CATCH();
    1441                 :             :     {
    1442                 :             :         /* Uncaught error while executing portal: mark it dead */
    1443                 :          52 :         MarkPortalFailed(portal);
    1444                 :             : 
    1445                 :             :         /* Restore global vars and propagate error */
    1446                 :          52 :         ActivePortal = saveActivePortal;
    1447                 :          52 :         CurrentResourceOwner = saveResourceOwner;
    1448                 :          52 :         PortalContext = savePortalContext;
    1449                 :             : 
    1450                 :          52 :         PG_RE_THROW();
    1451                 :             :     }
    1452         [ -  + ]:       34198 :     PG_END_TRY();
    1453                 :             : 
    1454                 :       34198 :     MemoryContextSwitchTo(oldContext);
    1455                 :             : 
    1456                 :             :     /* Mark portal not active */
    1457                 :       34198 :     portal->status = PORTAL_READY;
    1458                 :             : 
    1459                 :       34198 :     ActivePortal = saveActivePortal;
    1460                 :       34198 :     CurrentResourceOwner = saveResourceOwner;
    1461                 :       34198 :     PortalContext = savePortalContext;
    1462                 :             : 
    1463                 :       34198 :     return result;
    1464                 :             : }
    1465                 :             : 
    1466                 :             : /*
    1467                 :             :  * DoPortalRunFetch
    1468                 :             :  *      Guts of PortalRunFetch --- the portal context is already set up
    1469                 :             :  *
    1470                 :             :  * Here, count < 0 typically reverses the direction.  Also, count == FETCH_ALL
    1471                 :             :  * is interpreted as "all rows".  (cf FetchStmt.howMany)
    1472                 :             :  *
    1473                 :             :  * Returns number of rows processed (suitable for use in result tag)
    1474                 :             :  */
    1475                 :             : static uint64
    1476                 :       34246 : DoPortalRunFetch(Portal portal,
    1477                 :             :                  FetchDirection fdirection,
    1478                 :             :                  long count,
    1479                 :             :                  DestReceiver *dest)
    1480                 :             : {
    1481                 :             :     bool        forward;
    1482                 :             : 
    1483                 :             :     Assert(portal->strategy == PORTAL_ONE_SELECT ||
    1484                 :             :            portal->strategy == PORTAL_ONE_RETURNING ||
    1485                 :             :            portal->strategy == PORTAL_ONE_MOD_WITH ||
    1486                 :             :            portal->strategy == PORTAL_UTIL_SELECT);
    1487                 :             : 
    1488                 :             :     /*
    1489                 :             :      * Note: we disallow backwards fetch (including re-fetch of current row)
    1490                 :             :      * for NO SCROLL cursors, but we interpret that very loosely: you can use
    1491                 :             :      * any of the FetchDirection options, so long as the end result is to move
    1492                 :             :      * forwards by at least one row.  Currently it's sufficient to check for
    1493                 :             :      * NO SCROLL in DoPortalRewind() and in the forward == false path in
    1494                 :             :      * PortalRunSelect(); but someday we might prefer to account for that
    1495                 :             :      * restriction explicitly here.
    1496                 :             :      */
    1497   [ +  +  +  +  :       34246 :     switch (fdirection)
                      - ]
    1498                 :             :     {
    1499                 :       33726 :         case FETCH_FORWARD:
    1500         [ +  + ]:       33726 :             if (count < 0)
    1501                 :             :             {
    1502                 :           2 :                 fdirection = FETCH_BACKWARD;
    1503                 :           2 :                 count = -count;
    1504                 :             :             }
    1505                 :             :             /* fall out of switch to share code with FETCH_BACKWARD */
    1506                 :       33726 :             break;
    1507                 :         352 :         case FETCH_BACKWARD:
    1508         [ +  + ]:         352 :             if (count < 0)
    1509                 :             :             {
    1510                 :           1 :                 fdirection = FETCH_FORWARD;
    1511                 :           1 :                 count = -count;
    1512                 :             :             }
    1513                 :             :             /* fall out of switch to share code with FETCH_FORWARD */
    1514                 :         352 :             break;
    1515                 :         109 :         case FETCH_ABSOLUTE:
    1516         [ +  + ]:         109 :             if (count > 0)
    1517                 :             :             {
    1518                 :             :                 /*
    1519                 :             :                  * Definition: Rewind to start, advance count-1 rows, return
    1520                 :             :                  * next row (if any).
    1521                 :             :                  *
    1522                 :             :                  * In practice, if the goal is less than halfway back to the
    1523                 :             :                  * start, it's better to scan from where we are.
    1524                 :             :                  *
    1525                 :             :                  * Also, if current portalPos is outside the range of "long",
    1526                 :             :                  * do it the hard way to avoid possible overflow of the count
    1527                 :             :                  * argument to PortalRunSelect.  We must exclude exactly
    1528                 :             :                  * LONG_MAX, as well, lest the count look like FETCH_ALL.
    1529                 :             :                  *
    1530                 :             :                  * In any case, we arrange to fetch the target row going
    1531                 :             :                  * forwards.
    1532                 :             :                  */
    1533         [ +  + ]:          63 :                 if ((uint64) (count - 1) <= portal->portalPos / 2 ||
    1534         [ -  + ]:          25 :                     portal->portalPos >= (uint64) LONG_MAX)
    1535                 :             :                 {
    1536                 :          38 :                     DoPortalRewind(portal);
    1537         [ -  + ]:          34 :                     if (count > 1)
    1538                 :           0 :                         PortalRunSelect(portal, true, count - 1,
    1539                 :             :                                         None_Receiver);
    1540                 :             :                 }
    1541                 :             :                 else
    1542                 :             :                 {
    1543                 :          25 :                     long        pos = (long) portal->portalPos;
    1544                 :             : 
    1545         [ -  + ]:          25 :                     if (portal->atEnd)
    1546                 :           0 :                         pos++;  /* need one extra fetch if off end */
    1547         [ +  + ]:          25 :                     if (count <= pos)
    1548                 :           8 :                         PortalRunSelect(portal, false, pos - count + 1,
    1549                 :             :                                         None_Receiver);
    1550         [ +  + ]:          17 :                     else if (count > pos + 1)
    1551                 :           8 :                         PortalRunSelect(portal, true, count - pos - 1,
    1552                 :             :                                         None_Receiver);
    1553                 :             :                 }
    1554                 :          55 :                 return PortalRunSelect(portal, true, 1L, dest);
    1555                 :             :             }
    1556         [ +  + ]:          46 :             else if (count < 0)
    1557                 :             :             {
    1558                 :             :                 /*
    1559                 :             :                  * Definition: Advance to end, back up abs(count)-1 rows,
    1560                 :             :                  * return prior row (if any).  We could optimize this if we
    1561                 :             :                  * knew in advance where the end was, but typically we won't.
    1562                 :             :                  * (Is it worth considering case where count > half of size of
    1563                 :             :                  * query?  We could rewind once we know the size ...)
    1564                 :             :                  */
    1565                 :          38 :                 PortalRunSelect(portal, true, FETCH_ALL, None_Receiver);
    1566         [ -  + ]:          38 :                 if (count < -1)
    1567                 :           0 :                     PortalRunSelect(portal, false, -count - 1, None_Receiver);
    1568                 :          38 :                 return PortalRunSelect(portal, false, 1L, dest);
    1569                 :             :             }
    1570                 :             :             else
    1571                 :             :             {
    1572                 :             :                 /* count == 0 */
    1573                 :             :                 /* Rewind to start, return zero rows */
    1574                 :           8 :                 DoPortalRewind(portal);
    1575                 :           8 :                 return PortalRunSelect(portal, true, 0L, dest);
    1576                 :             :             }
    1577                 :             :             break;
    1578                 :          59 :         case FETCH_RELATIVE:
    1579         [ +  + ]:          59 :             if (count > 0)
    1580                 :             :             {
    1581                 :             :                 /*
    1582                 :             :                  * Definition: advance count-1 rows, return next row (if any).
    1583                 :             :                  */
    1584         [ +  + ]:          26 :                 if (count > 1)
    1585                 :          17 :                     PortalRunSelect(portal, true, count - 1, None_Receiver);
    1586                 :          26 :                 return PortalRunSelect(portal, true, 1L, dest);
    1587                 :             :             }
    1588         [ +  + ]:          33 :             else if (count < 0)
    1589                 :             :             {
    1590                 :             :                 /*
    1591                 :             :                  * Definition: back up abs(count)-1 rows, return prior row (if
    1592                 :             :                  * any).
    1593                 :             :                  */
    1594         [ +  + ]:          21 :                 if (count < -1)
    1595                 :          12 :                     PortalRunSelect(portal, false, -count - 1, None_Receiver);
    1596                 :          21 :                 return PortalRunSelect(portal, false, 1L, dest);
    1597                 :             :             }
    1598                 :             :             else
    1599                 :             :             {
    1600                 :             :                 /* count == 0 */
    1601                 :             :                 /* Same as FETCH FORWARD 0, so fall out of switch */
    1602                 :          12 :                 fdirection = FETCH_FORWARD;
    1603                 :             :             }
    1604                 :          12 :             break;
    1605                 :           0 :         default:
    1606         [ #  # ]:           0 :             elog(ERROR, "bogus direction");
    1607                 :             :             break;
    1608                 :             :     }
    1609                 :             : 
    1610                 :             :     /*
    1611                 :             :      * Get here with fdirection == FETCH_FORWARD or FETCH_BACKWARD, and count
    1612                 :             :      * >= 0.
    1613                 :             :      */
    1614                 :       34090 :     forward = (fdirection == FETCH_FORWARD);
    1615                 :             : 
    1616                 :             :     /*
    1617                 :             :      * Zero count means to re-fetch the current row, if any (per SQL)
    1618                 :             :      */
    1619         [ +  + ]:       34090 :     if (count == 0)
    1620                 :             :     {
    1621                 :             :         bool        on_row;
    1622                 :             : 
    1623                 :             :         /* Are we sitting on a row? */
    1624   [ +  -  +  - ]:          12 :         on_row = (!portal->atStart && !portal->atEnd);
    1625                 :             : 
    1626         [ -  + ]:          12 :         if (dest->mydest == DestNone)
    1627                 :             :         {
    1628                 :             :             /* MOVE 0 returns 0/1 based on if FETCH 0 would return a row */
    1629                 :           0 :             return on_row ? 1 : 0;
    1630                 :             :         }
    1631                 :             :         else
    1632                 :             :         {
    1633                 :             :             /*
    1634                 :             :              * If we are sitting on a row, back up one so we can re-fetch it.
    1635                 :             :              * If we are not sitting on a row, we still have to start up and
    1636                 :             :              * shut down the executor so that the destination is initialized
    1637                 :             :              * and shut down correctly; so keep going.  To PortalRunSelect,
    1638                 :             :              * count == 0 means we will retrieve no row.
    1639                 :             :              */
    1640         [ +  - ]:          12 :             if (on_row)
    1641                 :             :             {
    1642                 :          12 :                 PortalRunSelect(portal, false, 1L, None_Receiver);
    1643                 :             :                 /* Set up to fetch one row forward */
    1644                 :           8 :                 count = 1;
    1645                 :           8 :                 forward = true;
    1646                 :             :             }
    1647                 :             :         }
    1648                 :             :     }
    1649                 :             : 
    1650                 :             :     /*
    1651                 :             :      * Optimize MOVE BACKWARD ALL into a Rewind.
    1652                 :             :      */
    1653   [ +  +  +  +  :       34086 :     if (!forward && count == FETCH_ALL && dest->mydest == DestNone)
                   +  + ]
    1654                 :             :     {
    1655                 :          20 :         uint64      result = portal->portalPos;
    1656                 :             : 
    1657   [ +  +  +  + ]:          20 :         if (result > 0 && !portal->atEnd)
    1658                 :           4 :             result--;
    1659                 :          20 :         DoPortalRewind(portal);
    1660                 :          20 :         return result;
    1661                 :             :     }
    1662                 :             : 
    1663                 :       34066 :     return PortalRunSelect(portal, forward, count, dest);
    1664                 :             : }
    1665                 :             : 
    1666                 :             : /*
    1667                 :             :  * DoPortalRewind - rewind a Portal to starting point
    1668                 :             :  */
    1669                 :             : static void
    1670                 :          66 : DoPortalRewind(Portal portal)
    1671                 :             : {
    1672                 :             :     QueryDesc  *queryDesc;
    1673                 :             : 
    1674                 :             :     /*
    1675                 :             :      * No work is needed if we've not advanced nor attempted to advance the
    1676                 :             :      * cursor (and we don't want to throw a NO SCROLL error in this case).
    1677                 :             :      */
    1678   [ +  +  +  - ]:          66 :     if (portal->atStart && !portal->atEnd)
    1679                 :          12 :         return;
    1680                 :             : 
    1681                 :             :     /* Otherwise, cursor must allow scrolling */
    1682         [ +  + ]:          54 :     if (portal->cursorOptions & CURSOR_OPT_NO_SCROLL)
    1683         [ +  - ]:           4 :         ereport(ERROR,
    1684                 :             :                 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
    1685                 :             :                  errmsg("cursor can only scan forward"),
    1686                 :             :                  errhint("Declare it with SCROLL option to enable backward scan.")));
    1687                 :             : 
    1688                 :             :     /* Rewind holdStore, if we have one */
    1689         [ +  + ]:          50 :     if (portal->holdStore)
    1690                 :             :     {
    1691                 :             :         MemoryContext oldcontext;
    1692                 :             : 
    1693                 :           4 :         oldcontext = MemoryContextSwitchTo(portal->holdContext);
    1694                 :           4 :         tuplestore_rescan(portal->holdStore);
    1695                 :           4 :         MemoryContextSwitchTo(oldcontext);
    1696                 :             :     }
    1697                 :             : 
    1698                 :             :     /* Rewind executor, if active */
    1699                 :          50 :     queryDesc = portal->queryDesc;
    1700         [ +  + ]:          50 :     if (queryDesc)
    1701                 :             :     {
    1702                 :          46 :         PushActiveSnapshot(queryDesc->snapshot);
    1703                 :          46 :         ExecutorRewind(queryDesc);
    1704                 :          46 :         PopActiveSnapshot();
    1705                 :             :     }
    1706                 :             : 
    1707                 :          50 :     portal->atStart = true;
    1708                 :          50 :     portal->atEnd = false;
    1709                 :          50 :     portal->portalPos = 0;
    1710                 :             : }
    1711                 :             : 
    1712                 :             : /*
    1713                 :             :  * PlannedStmtRequiresSnapshot - what it says on the tin
    1714                 :             :  */
    1715                 :             : bool
    1716                 :      307253 : PlannedStmtRequiresSnapshot(PlannedStmt *pstmt)
    1717                 :             : {
    1718                 :      307253 :     Node       *utilityStmt = pstmt->utilityStmt;
    1719                 :             : 
    1720                 :             :     /* If it's not a utility statement, it definitely needs a snapshot */
    1721         [ +  + ]:      307253 :     if (utilityStmt == NULL)
    1722                 :       60290 :         return true;
    1723                 :             : 
    1724                 :             :     /*
    1725                 :             :      * Most utility statements need a snapshot, and the default presumption
    1726                 :             :      * about new ones should be that they do too.  Hence, enumerate those that
    1727                 :             :      * do not need one.
    1728                 :             :      *
    1729                 :             :      * Transaction control, LOCK, and SET must *not* set a snapshot, since
    1730                 :             :      * they need to be executable at the start of a transaction-snapshot-mode
    1731                 :             :      * transaction without freezing a snapshot.  By extension we allow SHOW
    1732                 :             :      * not to set a snapshot.  The other stmts listed are just efficiency
    1733                 :             :      * hacks.  Beware of listing anything that can modify the database --- if,
    1734                 :             :      * say, it has to update an index with expressions that invoke
    1735                 :             :      * user-defined functions, then it had better have a snapshot.
    1736                 :             :      */
    1737         [ +  + ]:      246963 :     if (IsA(utilityStmt, TransactionStmt) ||
    1738         [ +  + ]:      219876 :         IsA(utilityStmt, LockStmt) ||
    1739         [ +  + ]:      219276 :         IsA(utilityStmt, VariableSetStmt) ||
    1740         [ +  + ]:      194356 :         IsA(utilityStmt, VariableShowStmt) ||
    1741         [ +  + ]:      193799 :         IsA(utilityStmt, ConstraintsSetStmt) ||
    1742                 :             :     /* efficiency hacks from here down */
    1743         [ +  + ]:      193728 :         IsA(utilityStmt, FetchStmt) ||
    1744         [ +  + ]:      189225 :         IsA(utilityStmt, ListenStmt) ||
    1745         [ +  + ]:      189173 :         IsA(utilityStmt, NotifyStmt) ||
    1746         [ +  + ]:      189111 :         IsA(utilityStmt, UnlistenStmt) ||
    1747         [ +  + ]:      189049 :         IsA(utilityStmt, CheckPointStmt) ||
    1748         [ +  + ]:      188571 :         IsA(utilityStmt, WaitStmt))
    1749                 :       58683 :         return false;
    1750                 :             : 
    1751                 :      188280 :     return true;
    1752                 :             : }
    1753                 :             : 
    1754                 :             : /*
    1755                 :             :  * EnsurePortalSnapshotExists - recreate Portal-level snapshot, if needed
    1756                 :             :  *
    1757                 :             :  * Generally, we will have an active snapshot whenever we are executing
    1758                 :             :  * inside a Portal, unless the Portal's query is one of the utility
    1759                 :             :  * statements exempted from that rule (see PlannedStmtRequiresSnapshot).
    1760                 :             :  * However, procedures and DO blocks can commit or abort the transaction,
    1761                 :             :  * and thereby destroy all snapshots.  This function can be called to
    1762                 :             :  * re-establish the Portal-level snapshot when none exists.
    1763                 :             :  */
    1764                 :             : void
    1765                 :      290905 : EnsurePortalSnapshotExists(void)
    1766                 :             : {
    1767                 :             :     Portal      portal;
    1768                 :             : 
    1769                 :             :     /*
    1770                 :             :      * Nothing to do if a snapshot is set.  (We take it on faith that the
    1771                 :             :      * outermost active snapshot belongs to some Portal; or if there is no
    1772                 :             :      * Portal, it's somebody else's responsibility to manage things.)
    1773                 :             :      */
    1774         [ +  + ]:      290905 :     if (ActiveSnapshotSet())
    1775                 :      288655 :         return;
    1776                 :             : 
    1777                 :             :     /* Otherwise, we'd better have an active Portal */
    1778                 :        2250 :     portal = ActivePortal;
    1779         [ -  + ]:        2250 :     if (unlikely(portal == NULL))
    1780         [ #  # ]:           0 :         elog(ERROR, "cannot execute SQL without an outer snapshot or portal");
    1781                 :             :     Assert(portal->portalSnapshot == NULL);
    1782                 :             : 
    1783                 :             :     /*
    1784                 :             :      * Create a new snapshot, make it active, and remember it in portal.
    1785                 :             :      * Because the portal now references the snapshot, we must tell snapmgr.c
    1786                 :             :      * that the snapshot belongs to the portal's transaction level, else we
    1787                 :             :      * risk portalSnapshot becoming a dangling pointer.
    1788                 :             :      */
    1789                 :        2250 :     PushActiveSnapshotWithLevel(GetTransactionSnapshot(), portal->createLevel);
    1790                 :             :     /* PushActiveSnapshotWithLevel might have copied the snapshot */
    1791                 :        2250 :     portal->portalSnapshot = GetActiveSnapshot();
    1792                 :             : }
        

Generated by: LCOV version 2.0-1