LCOV - code coverage report
Current view: top level - src/backend/tcop - dest.c (source / functions) Hit Total Coverage
Test: PostgreSQL 15devel Lines: 58 67 86.6 %
Date: 2021-12-05 01:09:12 Functions: 9 9 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /*-------------------------------------------------------------------------
       2             :  *
       3             :  * dest.c
       4             :  *    support for communication destinations
       5             :  *
       6             :  *
       7             :  * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
       8             :  * Portions Copyright (c) 1994, Regents of the University of California
       9             :  *
      10             :  * IDENTIFICATION
      11             :  *    src/backend/tcop/dest.c
      12             :  *
      13             :  *-------------------------------------------------------------------------
      14             :  */
      15             : /*
      16             :  *   INTERFACE ROUTINES
      17             :  *      BeginCommand - initialize the destination at start of command
      18             :  *      CreateDestReceiver - create tuple receiver object for destination
      19             :  *      EndCommand - clean up the destination at end of command
      20             :  *      NullCommand - tell dest that an empty query string was recognized
      21             :  *      ReadyForQuery - tell dest that we are ready for a new query
      22             :  *
      23             :  *   NOTES
      24             :  *      These routines do the appropriate work before and after
      25             :  *      tuples are returned by a query to keep the backend and the
      26             :  *      "destination" portals synchronized.
      27             :  */
      28             : 
      29             : #include "postgres.h"
      30             : 
      31             : #include "access/printsimple.h"
      32             : #include "access/printtup.h"
      33             : #include "access/xact.h"
      34             : #include "commands/copy.h"
      35             : #include "commands/createas.h"
      36             : #include "commands/matview.h"
      37             : #include "executor/functions.h"
      38             : #include "executor/tqueue.h"
      39             : #include "executor/tstoreReceiver.h"
      40             : #include "libpq/libpq.h"
      41             : #include "libpq/pqformat.h"
      42             : #include "utils/portal.h"
      43             : 
      44             : 
      45             : /* ----------------
      46             :  *      dummy DestReceiver functions
      47             :  * ----------------
      48             :  */
      49             : static bool
      50      890642 : donothingReceive(TupleTableSlot *slot, DestReceiver *self)
      51             : {
      52      890642 :     return true;
      53             : }
      54             : 
      55             : static void
      56       42188 : donothingStartup(DestReceiver *self, int operation, TupleDesc typeinfo)
      57             : {
      58       42188 : }
      59             : 
      60             : static void
      61      511480 : donothingCleanup(DestReceiver *self)
      62             : {
      63             :     /* this is used for both shutdown and destroy methods */
      64      511480 : }
      65             : 
      66             : /* ----------------
      67             :  *      static DestReceiver structs for dest types needing no local state
      68             :  * ----------------
      69             :  */
      70             : static const DestReceiver donothingDR = {
      71             :     donothingReceive, donothingStartup, donothingCleanup, donothingCleanup,
      72             :     DestNone
      73             : };
      74             : 
      75             : static const DestReceiver debugtupDR = {
      76             :     debugtup, debugStartup, donothingCleanup, donothingCleanup,
      77             :     DestDebug
      78             : };
      79             : 
      80             : static const DestReceiver printsimpleDR = {
      81             :     printsimple, printsimple_startup, donothingCleanup, donothingCleanup,
      82             :     DestRemoteSimple
      83             : };
      84             : 
      85             : static const DestReceiver spi_printtupDR = {
      86             :     spi_printtup, spi_dest_startup, donothingCleanup, donothingCleanup,
      87             :     DestSPI
      88             : };
      89             : 
      90             : /*
      91             :  * Globally available receiver for DestNone.
      92             :  *
      93             :  * It's ok to cast the constness away as any modification of the none receiver
      94             :  * would be a bug (which gets easier to catch this way).
      95             :  */
      96             : DestReceiver *None_Receiver = (DestReceiver *) &donothingDR;
      97             : 
      98             : /* ----------------
      99             :  *      BeginCommand - initialize the destination at start of command
     100             :  * ----------------
     101             :  */
     102             : void
     103      782278 : BeginCommand(CommandTag commandTag, CommandDest dest)
     104             : {
     105             :     /* Nothing to do at present */
     106      782278 : }
     107             : 
     108             : /* ----------------
     109             :  *      CreateDestReceiver - return appropriate receiver function set for dest
     110             :  * ----------------
     111             :  */
     112             : DestReceiver *
     113      952806 : CreateDestReceiver(CommandDest dest)
     114             : {
     115             :     /*
     116             :      * It's ok to cast the constness away as any modification of the none
     117             :      * receiver would be a bug (which gets easier to catch this way).
     118             :      */
     119             : 
     120      952806 :     switch (dest)
     121             :     {
     122      404258 :         case DestRemote:
     123             :         case DestRemoteExecute:
     124      404258 :             return printtup_create_DR(dest);
     125             : 
     126        1656 :         case DestRemoteSimple:
     127        1656 :             return unconstify(DestReceiver *, &printsimpleDR);
     128             : 
     129         994 :         case DestNone:
     130         994 :             return unconstify(DestReceiver *, &donothingDR);
     131             : 
     132      371622 :         case DestDebug:
     133      371622 :             return unconstify(DestReceiver *, &debugtupDR);
     134             : 
     135       84198 :         case DestSPI:
     136       84198 :             return unconstify(DestReceiver *, &spi_printtupDR);
     137             : 
     138       23692 :         case DestTuplestore:
     139       23692 :             return CreateTuplestoreDestReceiver();
     140             : 
     141           0 :         case DestIntoRel:
     142           0 :             return CreateIntoRelDestReceiver(NULL);
     143             : 
     144         144 :         case DestCopyOut:
     145         144 :             return CreateCopyDestReceiver();
     146             : 
     147       66242 :         case DestSQLFunction:
     148       66242 :             return CreateSQLFunctionDestReceiver();
     149             : 
     150           0 :         case DestTransientRel:
     151           0 :             return CreateTransientRelDestReceiver(InvalidOid);
     152             : 
     153           0 :         case DestTupleQueue:
     154           0 :             return CreateTupleQueueDestReceiver(NULL);
     155             :     }
     156             : 
     157             :     /* should never get here */
     158           0 :     pg_unreachable();
     159             : }
     160             : 
     161             : /* ----------------
     162             :  *      EndCommand - clean up the destination at end of command
     163             :  * ----------------
     164             :  */
     165             : void
     166      761586 : EndCommand(const QueryCompletion *qc, CommandDest dest, bool force_undecorated_output)
     167             : {
     168             :     char        completionTag[COMPLETION_TAG_BUFSIZE];
     169             :     CommandTag  tag;
     170             :     const char *tagname;
     171             : 
     172      761586 :     switch (dest)
     173             :     {
     174      389964 :         case DestRemote:
     175             :         case DestRemoteExecute:
     176             :         case DestRemoteSimple:
     177             : 
     178             :             /*
     179             :              * We assume the tagname is plain ASCII and therefore requires no
     180             :              * encoding conversion.
     181             :              *
     182             :              * We no longer display LastOid, but to preserve the wire
     183             :              * protocol, we write InvalidOid where the LastOid used to be
     184             :              * written.
     185             :              *
     186             :              * All cases where LastOid was written also write nprocessed
     187             :              * count, so just Assert that rather than having an extra test.
     188             :              */
     189      389964 :             tag = qc->commandTag;
     190      389964 :             tagname = GetCommandTagName(tag);
     191             : 
     192      389964 :             if (command_tag_display_rowcount(tag) && !force_undecorated_output)
     193      247168 :                 snprintf(completionTag, COMPLETION_TAG_BUFSIZE,
     194             :                          tag == CMDTAG_INSERT ?
     195             :                          "%s 0 " UINT64_FORMAT : "%s " UINT64_FORMAT,
     196             :                          tagname, qc->nprocessed);
     197             :             else
     198      142796 :                 snprintf(completionTag, COMPLETION_TAG_BUFSIZE, "%s", tagname);
     199      389964 :             pq_putmessage('C', completionTag, strlen(completionTag) + 1);
     200             : 
     201      761586 :         case DestNone:
     202             :         case DestDebug:
     203             :         case DestSPI:
     204             :         case DestTuplestore:
     205             :         case DestIntoRel:
     206             :         case DestCopyOut:
     207             :         case DestSQLFunction:
     208             :         case DestTransientRel:
     209             :         case DestTupleQueue:
     210      761586 :             break;
     211             :     }
     212      761586 : }
     213             : 
     214             : /* ----------------
     215             :  *      EndReplicationCommand - stripped down version of EndCommand
     216             :  *
     217             :  *      For use by replication commands.
     218             :  * ----------------
     219             :  */
     220             : void
     221        2562 : EndReplicationCommand(const char *commandTag)
     222             : {
     223        2562 :     pq_putmessage('C', commandTag, strlen(commandTag) + 1);
     224        2562 : }
     225             : 
     226             : /* ----------------
     227             :  *      NullCommand - tell dest that an empty query string was recognized
     228             :  *
     229             :  *      This ensures that there will be a recognizable end to the response
     230             :  *      to an Execute message in the extended query protocol.
     231             :  * ----------------
     232             :  */
     233             : void
     234         526 : NullCommand(CommandDest dest)
     235             : {
     236         526 :     switch (dest)
     237             :     {
     238         526 :         case DestRemote:
     239             :         case DestRemoteExecute:
     240             :         case DestRemoteSimple:
     241             : 
     242             :             /* Tell the FE that we saw an empty query string */
     243         526 :             pq_putemptymessage('I');
     244         526 :             break;
     245             : 
     246           0 :         case DestNone:
     247             :         case DestDebug:
     248             :         case DestSPI:
     249             :         case DestTuplestore:
     250             :         case DestIntoRel:
     251             :         case DestCopyOut:
     252             :         case DestSQLFunction:
     253             :         case DestTransientRel:
     254             :         case DestTupleQueue:
     255           0 :             break;
     256             :     }
     257         526 : }
     258             : 
     259             : /* ----------------
     260             :  *      ReadyForQuery - tell dest that we are ready for a new query
     261             :  *
     262             :  *      The ReadyForQuery message is sent so that the FE can tell when
     263             :  *      we are done processing a query string.
     264             :  *      In versions 3.0 and up, it also carries a transaction state indicator.
     265             :  *
     266             :  *      Note that by flushing the stdio buffer here, we can avoid doing it
     267             :  *      most other places and thus reduce the number of separate packets sent.
     268             :  * ----------------
     269             :  */
     270             : void
     271      736874 : ReadyForQuery(CommandDest dest)
     272             : {
     273      736874 :     switch (dest)
     274             :     {
     275      404758 :         case DestRemote:
     276             :         case DestRemoteExecute:
     277             :         case DestRemoteSimple:
     278             :             {
     279             :                 StringInfoData buf;
     280             : 
     281      404758 :                 pq_beginmessage(&buf, 'Z');
     282      404758 :                 pq_sendbyte(&buf, TransactionBlockStatusCode());
     283      404758 :                 pq_endmessage(&buf);
     284             :             }
     285             :             /* Flush output at end of cycle in any case. */
     286      404758 :             pq_flush();
     287      404758 :             break;
     288             : 
     289      332116 :         case DestNone:
     290             :         case DestDebug:
     291             :         case DestSPI:
     292             :         case DestTuplestore:
     293             :         case DestIntoRel:
     294             :         case DestCopyOut:
     295             :         case DestSQLFunction:
     296             :         case DestTransientRel:
     297             :         case DestTupleQueue:
     298      332116 :             break;
     299             :     }
     300      736874 : }

Generated by: LCOV version 1.14