PostgreSQL Source Code  git master
postgres.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * postgres.c
4  * POSTGRES C Backend Interface
5  *
6  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994, Regents of the University of California
8  *
9  *
10  * IDENTIFICATION
11  * src/backend/tcop/postgres.c
12  *
13  * NOTES
14  * this is the "main" module of the postgres backend and
15  * hence the main module of the "traffic cop".
16  *
17  *-------------------------------------------------------------------------
18  */
19 
20 #include "postgres.h"
21 
22 #include <fcntl.h>
23 #include <limits.h>
24 #include <signal.h>
25 #include <unistd.h>
26 #include <sys/resource.h>
27 #include <sys/socket.h>
28 #include <sys/time.h>
29 
30 #ifdef USE_VALGRIND
31 #include <valgrind/valgrind.h>
32 #endif
33 
34 #include "access/parallel.h"
35 #include "access/printtup.h"
36 #include "access/xact.h"
37 #include "catalog/pg_type.h"
38 #include "commands/async.h"
39 #include "commands/event_trigger.h"
40 #include "commands/prepare.h"
41 #include "common/pg_prng.h"
42 #include "jit/jit.h"
43 #include "libpq/libpq.h"
44 #include "libpq/pqformat.h"
45 #include "libpq/pqsignal.h"
46 #include "mb/pg_wchar.h"
47 #include "mb/stringinfo_mb.h"
48 #include "miscadmin.h"
49 #include "nodes/print.h"
50 #include "optimizer/optimizer.h"
51 #include "parser/analyze.h"
52 #include "parser/parser.h"
53 #include "pg_getopt.h"
54 #include "pg_trace.h"
55 #include "pgstat.h"
56 #include "postmaster/autovacuum.h"
57 #include "postmaster/interrupt.h"
58 #include "postmaster/postmaster.h"
61 #include "replication/slot.h"
62 #include "replication/walsender.h"
63 #include "rewrite/rewriteHandler.h"
64 #include "storage/bufmgr.h"
65 #include "storage/ipc.h"
66 #include "storage/pmsignal.h"
67 #include "storage/proc.h"
68 #include "storage/procsignal.h"
69 #include "storage/sinval.h"
70 #include "tcop/fastpath.h"
71 #include "tcop/pquery.h"
72 #include "tcop/tcopprot.h"
73 #include "tcop/utility.h"
74 #include "utils/guc_hooks.h"
75 #include "utils/injection_point.h"
76 #include "utils/lsyscache.h"
77 #include "utils/memutils.h"
78 #include "utils/ps_status.h"
79 #include "utils/snapmgr.h"
80 #include "utils/timeout.h"
81 #include "utils/timestamp.h"
82 
83 /* ----------------
84  * global variables
85  * ----------------
86  */
87 const char *debug_query_string; /* client-supplied query string */
88 
89 /* Note: whereToSendOutput is initialized for the bootstrap/standalone case */
91 
92 /* flag for logging end of session */
93 bool Log_disconnections = false;
94 
96 
97 /* GUC variable for maximum stack depth (measured in kilobytes) */
98 int max_stack_depth = 100;
99 
100 /* wait N seconds to allow attach from a debugger */
102 
103 /* Time between checks that the client is still connected. */
105 
106 /* ----------------
107  * private typedefs etc
108  * ----------------
109  */
110 
111 /* type of argument for bind_param_error_callback */
112 typedef struct BindParamCbData
113 {
114  const char *portalName;
115  int paramno; /* zero-based param number, or -1 initially */
116  const char *paramval; /* textual input string, if available */
118 
119 /* ----------------
120  * private variables
121  * ----------------
122  */
123 
124 /* max_stack_depth converted to bytes for speed of checking */
125 static long max_stack_depth_bytes = 100 * 1024L;
126 
127 /*
128  * Stack base pointer -- initialized by PostmasterMain and inherited by
129  * subprocesses (but see also InitPostmasterChild).
130  */
131 static char *stack_base_ptr = NULL;
132 
133 /*
134  * Flag to keep track of whether we have started a transaction.
135  * For extended query protocol this has to be remembered across messages.
136  */
137 static bool xact_started = false;
138 
139 /*
140  * Flag to indicate that we are doing the outer loop's read-from-client,
141  * as opposed to any random read from client that might happen within
142  * commands like COPY FROM STDIN.
143  */
144 static bool DoingCommandRead = false;
145 
146 /*
147  * Flags to implement skip-till-Sync-after-error behavior for messages of
148  * the extended query protocol.
149  */
150 static bool doing_extended_query_message = false;
151 static bool ignore_till_sync = false;
152 
153 /*
154  * If an unnamed prepared statement exists, it's stored here.
155  * We keep it separate from the hashtable kept by commands/prepare.c
156  * in order to reduce overhead for short-lived queries.
157  */
159 
160 /* assorted command-line switches */
161 static const char *userDoption = NULL; /* -D switch */
162 static bool EchoQuery = false; /* -E switch */
163 static bool UseSemiNewlineNewline = false; /* -j switch */
164 
165 /* whether or not, and why, we were canceled by conflict with recovery */
166 static volatile sig_atomic_t RecoveryConflictPending = false;
167 static volatile sig_atomic_t RecoveryConflictPendingReasons[NUM_PROCSIGNALS];
168 
169 /* reused buffer to pass to SendRowDescriptionMessage() */
172 
173 /* ----------------------------------------------------------------
174  * decls for routines only used in this file
175  * ----------------------------------------------------------------
176  */
177 static int InteractiveBackend(StringInfo inBuf);
178 static int interactive_getc(void);
179 static int SocketBackend(StringInfo inBuf);
180 static int ReadCommand(StringInfo inBuf);
181 static void forbidden_in_wal_sender(char firstchar);
182 static bool check_log_statement(List *stmt_list);
183 static int errdetail_execute(List *raw_parsetree_list);
184 static int errdetail_params(ParamListInfo params);
185 static int errdetail_abort(void);
186 static void bind_param_error_callback(void *arg);
187 static void start_xact_command(void);
188 static void finish_xact_command(void);
189 static bool IsTransactionExitStmt(Node *parsetree);
190 static bool IsTransactionExitStmtList(List *pstmts);
191 static bool IsTransactionStmtList(List *pstmts);
192 static void drop_unnamed_stmt(void);
193 static void log_disconnections(int code, Datum arg);
194 static void enable_statement_timeout(void);
195 static void disable_statement_timeout(void);
196 
197 
198 /* ----------------------------------------------------------------
199  * infrastructure for valgrind debugging
200  * ----------------------------------------------------------------
201  */
202 #ifdef USE_VALGRIND
203 /* This variable should be set at the top of the main loop. */
204 static unsigned int old_valgrind_error_count;
205 
206 /*
207  * If Valgrind detected any errors since old_valgrind_error_count was updated,
208  * report the current query as the cause. This should be called at the end
209  * of message processing.
210  */
211 static void
212 valgrind_report_error_query(const char *query)
213 {
214  unsigned int valgrind_error_count = VALGRIND_COUNT_ERRORS;
215 
216  if (unlikely(valgrind_error_count != old_valgrind_error_count) &&
217  query != NULL)
218  VALGRIND_PRINTF("Valgrind detected %u error(s) during execution of \"%s\"\n",
219  valgrind_error_count - old_valgrind_error_count,
220  query);
221 }
222 
223 #else /* !USE_VALGRIND */
224 #define valgrind_report_error_query(query) ((void) 0)
225 #endif /* USE_VALGRIND */
226 
227 
228 /* ----------------------------------------------------------------
229  * routines to obtain user input
230  * ----------------------------------------------------------------
231  */
232 
233 /* ----------------
234  * InteractiveBackend() is called for user interactive connections
235  *
236  * the string entered by the user is placed in its parameter inBuf,
237  * and we act like a Q message was received.
238  *
239  * EOF is returned if end-of-file input is seen; time to shut down.
240  * ----------------
241  */
242 
243 static int
245 {
246  int c; /* character read from getc() */
247 
248  /*
249  * display a prompt and obtain input from the user
250  */
251  printf("backend> ");
252  fflush(stdout);
253 
254  resetStringInfo(inBuf);
255 
256  /*
257  * Read characters until EOF or the appropriate delimiter is seen.
258  */
259  while ((c = interactive_getc()) != EOF)
260  {
261  if (c == '\n')
262  {
264  {
265  /*
266  * In -j mode, semicolon followed by two newlines ends the
267  * command; otherwise treat newline as regular character.
268  */
269  if (inBuf->len > 1 &&
270  inBuf->data[inBuf->len - 1] == '\n' &&
271  inBuf->data[inBuf->len - 2] == ';')
272  {
273  /* might as well drop the second newline */
274  break;
275  }
276  }
277  else
278  {
279  /*
280  * In plain mode, newline ends the command unless preceded by
281  * backslash.
282  */
283  if (inBuf->len > 0 &&
284  inBuf->data[inBuf->len - 1] == '\\')
285  {
286  /* discard backslash from inBuf */
287  inBuf->data[--inBuf->len] = '\0';
288  /* discard newline too */
289  continue;
290  }
291  else
292  {
293  /* keep the newline character, but end the command */
294  appendStringInfoChar(inBuf, '\n');
295  break;
296  }
297  }
298  }
299 
300  /* Not newline, or newline treated as regular character */
301  appendStringInfoChar(inBuf, (char) c);
302  }
303 
304  /* No input before EOF signal means time to quit. */
305  if (c == EOF && inBuf->len == 0)
306  return EOF;
307 
308  /*
309  * otherwise we have a user query so process it.
310  */
311 
312  /* Add '\0' to make it look the same as message case. */
313  appendStringInfoChar(inBuf, (char) '\0');
314 
315  /*
316  * if the query echo flag was given, print the query..
317  */
318  if (EchoQuery)
319  printf("statement: %s\n", inBuf->data);
320  fflush(stdout);
321 
322  return 'Q';
323 }
324 
325 /*
326  * interactive_getc -- collect one character from stdin
327  *
328  * Even though we are not reading from a "client" process, we still want to
329  * respond to signals, particularly SIGTERM/SIGQUIT.
330  */
331 static int
333 {
334  int c;
335 
336  /*
337  * This will not process catchup interrupts or notifications while
338  * reading. But those can't really be relevant for a standalone backend
339  * anyway. To properly handle SIGTERM there's a hack in die() that
340  * directly processes interrupts at this stage...
341  */
343 
344  c = getc(stdin);
345 
347 
348  return c;
349 }
350 
351 /* ----------------
352  * SocketBackend() Is called for frontend-backend connections
353  *
354  * Returns the message type code, and loads message body data into inBuf.
355  *
356  * EOF is returned if the connection is lost.
357  * ----------------
358  */
359 static int
361 {
362  int qtype;
363  int maxmsglen;
364 
365  /*
366  * Get message type code from the frontend.
367  */
369  pq_startmsgread();
370  qtype = pq_getbyte();
371 
372  if (qtype == EOF) /* frontend disconnected */
373  {
374  if (IsTransactionState())
376  (errcode(ERRCODE_CONNECTION_FAILURE),
377  errmsg("unexpected EOF on client connection with an open transaction")));
378  else
379  {
380  /*
381  * Can't send DEBUG log messages to client at this point. Since
382  * we're disconnecting right away, we don't need to restore
383  * whereToSendOutput.
384  */
386  ereport(DEBUG1,
387  (errcode(ERRCODE_CONNECTION_DOES_NOT_EXIST),
388  errmsg_internal("unexpected EOF on client connection")));
389  }
390  return qtype;
391  }
392 
393  /*
394  * Validate message type code before trying to read body; if we have lost
395  * sync, better to say "command unknown" than to run out of memory because
396  * we used garbage as a length word. We can also select a type-dependent
397  * limit on what a sane length word could be. (The limit could be chosen
398  * more granularly, but it's not clear it's worth fussing over.)
399  *
400  * This also gives us a place to set the doing_extended_query_message flag
401  * as soon as possible.
402  */
403  switch (qtype)
404  {
405  case PqMsg_Query:
406  maxmsglen = PQ_LARGE_MESSAGE_LIMIT;
408  break;
409 
410  case PqMsg_FunctionCall:
411  maxmsglen = PQ_LARGE_MESSAGE_LIMIT;
413  break;
414 
415  case PqMsg_Terminate:
416  maxmsglen = PQ_SMALL_MESSAGE_LIMIT;
418  ignore_till_sync = false;
419  break;
420 
421  case PqMsg_Bind:
422  case PqMsg_Parse:
423  maxmsglen = PQ_LARGE_MESSAGE_LIMIT;
425  break;
426 
427  case PqMsg_Close:
428  case PqMsg_Describe:
429  case PqMsg_Execute:
430  case PqMsg_Flush:
431  maxmsglen = PQ_SMALL_MESSAGE_LIMIT;
433  break;
434 
435  case PqMsg_Sync:
436  maxmsglen = PQ_SMALL_MESSAGE_LIMIT;
437  /* stop any active skip-till-Sync */
438  ignore_till_sync = false;
439  /* mark not-extended, so that a new error doesn't begin skip */
441  break;
442 
443  case PqMsg_CopyData:
444  maxmsglen = PQ_LARGE_MESSAGE_LIMIT;
446  break;
447 
448  case PqMsg_CopyDone:
449  case PqMsg_CopyFail:
450  maxmsglen = PQ_SMALL_MESSAGE_LIMIT;
452  break;
453 
454  default:
455 
456  /*
457  * Otherwise we got garbage from the frontend. We treat this as
458  * fatal because we have probably lost message boundary sync, and
459  * there's no good way to recover.
460  */
461  ereport(FATAL,
462  (errcode(ERRCODE_PROTOCOL_VIOLATION),
463  errmsg("invalid frontend message type %d", qtype)));
464  maxmsglen = 0; /* keep compiler quiet */
465  break;
466  }
467 
468  /*
469  * In protocol version 3, all frontend messages have a length word next
470  * after the type code; we can read the message contents independently of
471  * the type.
472  */
473  if (pq_getmessage(inBuf, maxmsglen))
474  return EOF; /* suitable message already logged */
476 
477  return qtype;
478 }
479 
480 /* ----------------
481  * ReadCommand reads a command from either the frontend or
482  * standard input, places it in inBuf, and returns the
483  * message type code (first byte of the message).
484  * EOF is returned if end of file.
485  * ----------------
486  */
487 static int
489 {
490  int result;
491 
493  result = SocketBackend(inBuf);
494  else
495  result = InteractiveBackend(inBuf);
496  return result;
497 }
498 
499 /*
500  * ProcessClientReadInterrupt() - Process interrupts specific to client reads
501  *
502  * This is called just before and after low-level reads.
503  * 'blocked' is true if no data was available to read and we plan to retry,
504  * false if about to read or done reading.
505  *
506  * Must preserve errno!
507  */
508 void
510 {
511  int save_errno = errno;
512 
513  if (DoingCommandRead)
514  {
515  /* Check for general interrupts that arrived before/while reading */
517 
518  /* Process sinval catchup interrupts, if any */
521 
522  /* Process notify interrupts, if any */
525  }
526  else if (ProcDiePending)
527  {
528  /*
529  * We're dying. If there is no data available to read, then it's safe
530  * (and sane) to handle that now. If we haven't tried to read yet,
531  * make sure the process latch is set, so that if there is no data
532  * then we'll come back here and die. If we're done reading, also
533  * make sure the process latch is set, as we might've undesirably
534  * cleared it while reading.
535  */
536  if (blocked)
538  else
539  SetLatch(MyLatch);
540  }
541 
542  errno = save_errno;
543 }
544 
545 /*
546  * ProcessClientWriteInterrupt() - Process interrupts specific to client writes
547  *
548  * This is called just before and after low-level writes.
549  * 'blocked' is true if no data could be written and we plan to retry,
550  * false if about to write or done writing.
551  *
552  * Must preserve errno!
553  */
554 void
556 {
557  int save_errno = errno;
558 
559  if (ProcDiePending)
560  {
561  /*
562  * We're dying. If it's not possible to write, then we should handle
563  * that immediately, else a stuck client could indefinitely delay our
564  * response to the signal. If we haven't tried to write yet, make
565  * sure the process latch is set, so that if the write would block
566  * then we'll come back here and die. If we're done writing, also
567  * make sure the process latch is set, as we might've undesirably
568  * cleared it while writing.
569  */
570  if (blocked)
571  {
572  /*
573  * Don't mess with whereToSendOutput if ProcessInterrupts wouldn't
574  * service ProcDiePending.
575  */
576  if (InterruptHoldoffCount == 0 && CritSectionCount == 0)
577  {
578  /*
579  * We don't want to send the client the error message, as a)
580  * that would possibly block again, and b) it would likely
581  * lead to loss of protocol sync because we may have already
582  * sent a partial protocol message.
583  */
586 
588  }
589  }
590  else
591  SetLatch(MyLatch);
592  }
593 
594  errno = save_errno;
595 }
596 
597 /*
598  * Do raw parsing (only).
599  *
600  * A list of parsetrees (RawStmt nodes) is returned, since there might be
601  * multiple commands in the given string.
602  *
603  * NOTE: for interactive queries, it is important to keep this routine
604  * separate from the analysis & rewrite stages. Analysis and rewriting
605  * cannot be done in an aborted transaction, since they require access to
606  * database tables. So, we rely on the raw parser to determine whether
607  * we've seen a COMMIT or ABORT command; when we are in abort state, other
608  * commands are not processed any further than the raw parse stage.
609  */
610 List *
611 pg_parse_query(const char *query_string)
612 {
613  List *raw_parsetree_list;
614 
615  TRACE_POSTGRESQL_QUERY_PARSE_START(query_string);
616 
617  if (log_parser_stats)
618  ResetUsage();
619 
620  raw_parsetree_list = raw_parser(query_string, RAW_PARSE_DEFAULT);
621 
622  if (log_parser_stats)
623  ShowUsage("PARSER STATISTICS");
624 
625 #ifdef COPY_PARSE_PLAN_TREES
626  /* Optional debugging check: pass raw parsetrees through copyObject() */
627  {
628  List *new_list = copyObject(raw_parsetree_list);
629 
630  /* This checks both copyObject() and the equal() routines... */
631  if (!equal(new_list, raw_parsetree_list))
632  elog(WARNING, "copyObject() failed to produce an equal raw parse tree");
633  else
634  raw_parsetree_list = new_list;
635  }
636 #endif
637 
638  /*
639  * Optional debugging check: pass raw parsetrees through
640  * outfuncs/readfuncs
641  */
642 #ifdef WRITE_READ_PARSE_PLAN_TREES
643  {
644  char *str = nodeToString(raw_parsetree_list);
645  List *new_list = stringToNodeWithLocations(str);
646 
647  pfree(str);
648  /* This checks both outfuncs/readfuncs and the equal() routines... */
649  if (!equal(new_list, raw_parsetree_list))
650  elog(WARNING, "outfuncs/readfuncs failed to produce an equal raw parse tree");
651  else
652  raw_parsetree_list = new_list;
653  }
654 #endif
655 
656  TRACE_POSTGRESQL_QUERY_PARSE_DONE(query_string);
657 
658  return raw_parsetree_list;
659 }
660 
661 /*
662  * Given a raw parsetree (gram.y output), and optionally information about
663  * types of parameter symbols ($n), perform parse analysis and rule rewriting.
664  *
665  * A list of Query nodes is returned, since either the analyzer or the
666  * rewriter might expand one query to several.
667  *
668  * NOTE: for reasons mentioned above, this must be separate from raw parsing.
669  */
670 List *
672  const char *query_string,
673  const Oid *paramTypes,
674  int numParams,
675  QueryEnvironment *queryEnv)
676 {
677  Query *query;
678  List *querytree_list;
679 
680  TRACE_POSTGRESQL_QUERY_REWRITE_START(query_string);
681 
682  /*
683  * (1) Perform parse analysis.
684  */
685  if (log_parser_stats)
686  ResetUsage();
687 
688  query = parse_analyze_fixedparams(parsetree, query_string, paramTypes, numParams,
689  queryEnv);
690 
691  if (log_parser_stats)
692  ShowUsage("PARSE ANALYSIS STATISTICS");
693 
694  /*
695  * (2) Rewrite the queries, as necessary
696  */
697  querytree_list = pg_rewrite_query(query);
698 
699  TRACE_POSTGRESQL_QUERY_REWRITE_DONE(query_string);
700 
701  return querytree_list;
702 }
703 
704 /*
705  * Do parse analysis and rewriting. This is the same as
706  * pg_analyze_and_rewrite_fixedparams except that it's okay to deduce
707  * information about $n symbol datatypes from context.
708  */
709 List *
711  const char *query_string,
712  Oid **paramTypes,
713  int *numParams,
714  QueryEnvironment *queryEnv)
715 {
716  Query *query;
717  List *querytree_list;
718 
719  TRACE_POSTGRESQL_QUERY_REWRITE_START(query_string);
720 
721  /*
722  * (1) Perform parse analysis.
723  */
724  if (log_parser_stats)
725  ResetUsage();
726 
727  query = parse_analyze_varparams(parsetree, query_string, paramTypes, numParams,
728  queryEnv);
729 
730  /*
731  * Check all parameter types got determined.
732  */
733  for (int i = 0; i < *numParams; i++)
734  {
735  Oid ptype = (*paramTypes)[i];
736 
737  if (ptype == InvalidOid || ptype == UNKNOWNOID)
738  ereport(ERROR,
739  (errcode(ERRCODE_INDETERMINATE_DATATYPE),
740  errmsg("could not determine data type of parameter $%d",
741  i + 1)));
742  }
743 
744  if (log_parser_stats)
745  ShowUsage("PARSE ANALYSIS STATISTICS");
746 
747  /*
748  * (2) Rewrite the queries, as necessary
749  */
750  querytree_list = pg_rewrite_query(query);
751 
752  TRACE_POSTGRESQL_QUERY_REWRITE_DONE(query_string);
753 
754  return querytree_list;
755 }
756 
757 /*
758  * Do parse analysis and rewriting. This is the same as
759  * pg_analyze_and_rewrite_fixedparams except that, instead of a fixed list of
760  * parameter datatypes, a parser callback is supplied that can do
761  * external-parameter resolution and possibly other things.
762  */
763 List *
765  const char *query_string,
766  ParserSetupHook parserSetup,
767  void *parserSetupArg,
768  QueryEnvironment *queryEnv)
769 {
770  Query *query;
771  List *querytree_list;
772 
773  TRACE_POSTGRESQL_QUERY_REWRITE_START(query_string);
774 
775  /*
776  * (1) Perform parse analysis.
777  */
778  if (log_parser_stats)
779  ResetUsage();
780 
781  query = parse_analyze_withcb(parsetree, query_string, parserSetup, parserSetupArg,
782  queryEnv);
783 
784  if (log_parser_stats)
785  ShowUsage("PARSE ANALYSIS STATISTICS");
786 
787  /*
788  * (2) Rewrite the queries, as necessary
789  */
790  querytree_list = pg_rewrite_query(query);
791 
792  TRACE_POSTGRESQL_QUERY_REWRITE_DONE(query_string);
793 
794  return querytree_list;
795 }
796 
797 /*
798  * Perform rewriting of a query produced by parse analysis.
799  *
800  * Note: query must just have come from the parser, because we do not do
801  * AcquireRewriteLocks() on it.
802  */
803 List *
805 {
806  List *querytree_list;
807 
808  if (Debug_print_parse)
809  elog_node_display(LOG, "parse tree", query,
811 
812  if (log_parser_stats)
813  ResetUsage();
814 
815  if (query->commandType == CMD_UTILITY)
816  {
817  /* don't rewrite utilities, just dump 'em into result list */
818  querytree_list = list_make1(query);
819  }
820  else
821  {
822  /* rewrite regular queries */
823  querytree_list = QueryRewrite(query);
824  }
825 
826  if (log_parser_stats)
827  ShowUsage("REWRITER STATISTICS");
828 
829 #ifdef COPY_PARSE_PLAN_TREES
830  /* Optional debugging check: pass querytree through copyObject() */
831  {
832  List *new_list;
833 
834  new_list = copyObject(querytree_list);
835  /* This checks both copyObject() and the equal() routines... */
836  if (!equal(new_list, querytree_list))
837  elog(WARNING, "copyObject() failed to produce an equal rewritten parse tree");
838  else
839  querytree_list = new_list;
840  }
841 #endif
842 
843 #ifdef WRITE_READ_PARSE_PLAN_TREES
844  /* Optional debugging check: pass querytree through outfuncs/readfuncs */
845  {
846  List *new_list = NIL;
847  ListCell *lc;
848 
849  foreach(lc, querytree_list)
850  {
851  Query *curr_query = lfirst_node(Query, lc);
852  char *str = nodeToString(curr_query);
853  Query *new_query = stringToNodeWithLocations(str);
854 
855  /*
856  * queryId is not saved in stored rules, but we must preserve it
857  * here to avoid breaking pg_stat_statements.
858  */
859  new_query->queryId = curr_query->queryId;
860 
861  new_list = lappend(new_list, new_query);
862  pfree(str);
863  }
864 
865  /* This checks both outfuncs/readfuncs and the equal() routines... */
866  if (!equal(new_list, querytree_list))
867  elog(WARNING, "outfuncs/readfuncs failed to produce an equal rewritten parse tree");
868  else
869  querytree_list = new_list;
870  }
871 #endif
872 
874  elog_node_display(LOG, "rewritten parse tree", querytree_list,
876 
877  return querytree_list;
878 }
879 
880 
881 /*
882  * Generate a plan for a single already-rewritten query.
883  * This is a thin wrapper around planner() and takes the same parameters.
884  */
885 PlannedStmt *
886 pg_plan_query(Query *querytree, const char *query_string, int cursorOptions,
887  ParamListInfo boundParams)
888 {
889  PlannedStmt *plan;
890 
891  /* Utility commands have no plans. */
892  if (querytree->commandType == CMD_UTILITY)
893  return NULL;
894 
895  /* Planner must have a snapshot in case it calls user-defined functions. */
897 
898  TRACE_POSTGRESQL_QUERY_PLAN_START();
899 
900  if (log_planner_stats)
901  ResetUsage();
902 
903  /* call the optimizer */
904  plan = planner(querytree, query_string, cursorOptions, boundParams);
905 
906  if (log_planner_stats)
907  ShowUsage("PLANNER STATISTICS");
908 
909 #ifdef COPY_PARSE_PLAN_TREES
910  /* Optional debugging check: pass plan tree through copyObject() */
911  {
912  PlannedStmt *new_plan = copyObject(plan);
913 
914  /*
915  * equal() currently does not have routines to compare Plan nodes, so
916  * don't try to test equality here. Perhaps fix someday?
917  */
918 #ifdef NOT_USED
919  /* This checks both copyObject() and the equal() routines... */
920  if (!equal(new_plan, plan))
921  elog(WARNING, "copyObject() failed to produce an equal plan tree");
922  else
923 #endif
924  plan = new_plan;
925  }
926 #endif
927 
928 #ifdef WRITE_READ_PARSE_PLAN_TREES
929  /* Optional debugging check: pass plan tree through outfuncs/readfuncs */
930  {
931  char *str;
932  PlannedStmt *new_plan;
933 
934  str = nodeToString(plan);
935  new_plan = stringToNodeWithLocations(str);
936  pfree(str);
937 
938  /*
939  * equal() currently does not have routines to compare Plan nodes, so
940  * don't try to test equality here. Perhaps fix someday?
941  */
942 #ifdef NOT_USED
943  /* This checks both outfuncs/readfuncs and the equal() routines... */
944  if (!equal(new_plan, plan))
945  elog(WARNING, "outfuncs/readfuncs failed to produce an equal plan tree");
946  else
947 #endif
948  plan = new_plan;
949  }
950 #endif
951 
952  /*
953  * Print plan if debugging.
954  */
955  if (Debug_print_plan)
957 
958  TRACE_POSTGRESQL_QUERY_PLAN_DONE();
959 
960  return plan;
961 }
962 
963 /*
964  * Generate plans for a list of already-rewritten queries.
965  *
966  * For normal optimizable statements, invoke the planner. For utility
967  * statements, just make a wrapper PlannedStmt node.
968  *
969  * The result is a list of PlannedStmt nodes.
970  */
971 List *
972 pg_plan_queries(List *querytrees, const char *query_string, int cursorOptions,
973  ParamListInfo boundParams)
974 {
975  List *stmt_list = NIL;
976  ListCell *query_list;
977 
978  foreach(query_list, querytrees)
979  {
980  Query *query = lfirst_node(Query, query_list);
981  PlannedStmt *stmt;
982 
983  if (query->commandType == CMD_UTILITY)
984  {
985  /* Utility commands require no planning. */
987  stmt->commandType = CMD_UTILITY;
988  stmt->canSetTag = query->canSetTag;
989  stmt->utilityStmt = query->utilityStmt;
990  stmt->stmt_location = query->stmt_location;
991  stmt->stmt_len = query->stmt_len;
992  stmt->queryId = query->queryId;
993  }
994  else
995  {
996  stmt = pg_plan_query(query, query_string, cursorOptions,
997  boundParams);
998  }
999 
1000  stmt_list = lappend(stmt_list, stmt);
1001  }
1002 
1003  return stmt_list;
1004 }
1005 
1006 
1007 /*
1008  * exec_simple_query
1009  *
1010  * Execute a "simple Query" protocol message.
1011  */
1012 static void
1013 exec_simple_query(const char *query_string)
1014 {
1016  MemoryContext oldcontext;
1017  List *parsetree_list;
1018  ListCell *parsetree_item;
1019  bool save_log_statement_stats = log_statement_stats;
1020  bool was_logged = false;
1021  bool use_implicit_block;
1022  char msec_str[32];
1023 
1024  /*
1025  * Report query to various monitoring facilities.
1026  */
1027  debug_query_string = query_string;
1028 
1029  pgstat_report_activity(STATE_RUNNING, query_string);
1030 
1031  TRACE_POSTGRESQL_QUERY_START(query_string);
1032 
1033  /*
1034  * We use save_log_statement_stats so ShowUsage doesn't report incorrect
1035  * results because ResetUsage wasn't called.
1036  */
1037  if (save_log_statement_stats)
1038  ResetUsage();
1039 
1040  /*
1041  * Start up a transaction command. All queries generated by the
1042  * query_string will be in this same command block, *unless* we find a
1043  * BEGIN/COMMIT/ABORT statement; we have to force a new xact command after
1044  * one of those, else bad things will happen in xact.c. (Note that this
1045  * will normally change current memory context.)
1046  */
1048 
1049  /*
1050  * Zap any pre-existing unnamed statement. (While not strictly necessary,
1051  * it seems best to define simple-Query mode as if it used the unnamed
1052  * statement and portal; this ensures we recover any storage used by prior
1053  * unnamed operations.)
1054  */
1056 
1057  /*
1058  * Switch to appropriate context for constructing parsetrees.
1059  */
1060  oldcontext = MemoryContextSwitchTo(MessageContext);
1061 
1062  /*
1063  * Do basic parsing of the query or queries (this should be safe even if
1064  * we are in aborted transaction state!)
1065  */
1066  parsetree_list = pg_parse_query(query_string);
1067 
1068  /* Log immediately if dictated by log_statement */
1069  if (check_log_statement(parsetree_list))
1070  {
1071  ereport(LOG,
1072  (errmsg("statement: %s", query_string),
1073  errhidestmt(true),
1074  errdetail_execute(parsetree_list)));
1075  was_logged = true;
1076  }
1077 
1078  /*
1079  * Switch back to transaction context to enter the loop.
1080  */
1081  MemoryContextSwitchTo(oldcontext);
1082 
1083  /*
1084  * For historical reasons, if multiple SQL statements are given in a
1085  * single "simple Query" message, we execute them as a single transaction,
1086  * unless explicit transaction control commands are included to make
1087  * portions of the list be separate transactions. To represent this
1088  * behavior properly in the transaction machinery, we use an "implicit"
1089  * transaction block.
1090  */
1091  use_implicit_block = (list_length(parsetree_list) > 1);
1092 
1093  /*
1094  * Run through the raw parsetree(s) and process each one.
1095  */
1096  foreach(parsetree_item, parsetree_list)
1097  {
1098  RawStmt *parsetree = lfirst_node(RawStmt, parsetree_item);
1099  bool snapshot_set = false;
1100  CommandTag commandTag;
1101  QueryCompletion qc;
1102  MemoryContext per_parsetree_context = NULL;
1103  List *querytree_list,
1104  *plantree_list;
1105  Portal portal;
1106  DestReceiver *receiver;
1107  int16 format;
1108  const char *cmdtagname;
1109  size_t cmdtaglen;
1110 
1111  pgstat_report_query_id(0, true);
1112 
1113  /*
1114  * Get the command name for use in status display (it also becomes the
1115  * default completion tag, down inside PortalRun). Set ps_status and
1116  * do any special start-of-SQL-command processing needed by the
1117  * destination.
1118  */
1119  commandTag = CreateCommandTag(parsetree->stmt);
1120  cmdtagname = GetCommandTagNameAndLen(commandTag, &cmdtaglen);
1121 
1122  set_ps_display_with_len(cmdtagname, cmdtaglen);
1123 
1124  BeginCommand(commandTag, dest);
1125 
1126  /*
1127  * If we are in an aborted transaction, reject all commands except
1128  * COMMIT/ABORT. It is important that this test occur before we try
1129  * to do parse analysis, rewrite, or planning, since all those phases
1130  * try to do database accesses, which may fail in abort state. (It
1131  * might be safe to allow some additional utility commands in this
1132  * state, but not many...)
1133  */
1135  !IsTransactionExitStmt(parsetree->stmt))
1136  ereport(ERROR,
1137  (errcode(ERRCODE_IN_FAILED_SQL_TRANSACTION),
1138  errmsg("current transaction is aborted, "
1139  "commands ignored until end of transaction block"),
1140  errdetail_abort()));
1141 
1142  /* Make sure we are in a transaction command */
1144 
1145  /*
1146  * If using an implicit transaction block, and we're not already in a
1147  * transaction block, start an implicit block to force this statement
1148  * to be grouped together with any following ones. (We must do this
1149  * each time through the loop; otherwise, a COMMIT/ROLLBACK in the
1150  * list would cause later statements to not be grouped.)
1151  */
1152  if (use_implicit_block)
1154 
1155  /* If we got a cancel signal in parsing or prior command, quit */
1157 
1158  /*
1159  * Set up a snapshot if parse analysis/planning will need one.
1160  */
1161  if (analyze_requires_snapshot(parsetree))
1162  {
1164  snapshot_set = true;
1165  }
1166 
1167  /*
1168  * OK to analyze, rewrite, and plan this query.
1169  *
1170  * Switch to appropriate context for constructing query and plan trees
1171  * (these can't be in the transaction context, as that will get reset
1172  * when the command is COMMIT/ROLLBACK). If we have multiple
1173  * parsetrees, we use a separate context for each one, so that we can
1174  * free that memory before moving on to the next one. But for the
1175  * last (or only) parsetree, just use MessageContext, which will be
1176  * reset shortly after completion anyway. In event of an error, the
1177  * per_parsetree_context will be deleted when MessageContext is reset.
1178  */
1179  if (lnext(parsetree_list, parsetree_item) != NULL)
1180  {
1181  per_parsetree_context =
1183  "per-parsetree message context",
1185  oldcontext = MemoryContextSwitchTo(per_parsetree_context);
1186  }
1187  else
1188  oldcontext = MemoryContextSwitchTo(MessageContext);
1189 
1190  querytree_list = pg_analyze_and_rewrite_fixedparams(parsetree, query_string,
1191  NULL, 0, NULL);
1192 
1193  plantree_list = pg_plan_queries(querytree_list, query_string,
1194  CURSOR_OPT_PARALLEL_OK, NULL);
1195 
1196  /*
1197  * Done with the snapshot used for parsing/planning.
1198  *
1199  * While it looks promising to reuse the same snapshot for query
1200  * execution (at least for simple protocol), unfortunately it causes
1201  * execution to use a snapshot that has been acquired before locking
1202  * any of the tables mentioned in the query. This creates user-
1203  * visible anomalies, so refrain. Refer to
1204  * https://postgr.es/m/flat/5075D8DF.6050500@fuzzy.cz for details.
1205  */
1206  if (snapshot_set)
1208 
1209  /* If we got a cancel signal in analysis or planning, quit */
1211 
1212  /*
1213  * Create unnamed portal to run the query or queries in. If there
1214  * already is one, silently drop it.
1215  */
1216  portal = CreatePortal("", true, true);
1217  /* Don't display the portal in pg_cursors */
1218  portal->visible = false;
1219 
1220  /*
1221  * We don't have to copy anything into the portal, because everything
1222  * we are passing here is in MessageContext or the
1223  * per_parsetree_context, and so will outlive the portal anyway.
1224  */
1225  PortalDefineQuery(portal,
1226  NULL,
1227  query_string,
1228  commandTag,
1229  plantree_list,
1230  NULL);
1231 
1232  /*
1233  * Start the portal. No parameters here.
1234  */
1235  PortalStart(portal, NULL, 0, InvalidSnapshot);
1236 
1237  /*
1238  * Select the appropriate output format: text unless we are doing a
1239  * FETCH from a binary cursor. (Pretty grotty to have to do this here
1240  * --- but it avoids grottiness in other places. Ah, the joys of
1241  * backward compatibility...)
1242  */
1243  format = 0; /* TEXT is default */
1244  if (IsA(parsetree->stmt, FetchStmt))
1245  {
1246  FetchStmt *stmt = (FetchStmt *) parsetree->stmt;
1247 
1248  if (!stmt->ismove)
1249  {
1250  Portal fportal = GetPortalByName(stmt->portalname);
1251 
1252  if (PortalIsValid(fportal) &&
1253  (fportal->cursorOptions & CURSOR_OPT_BINARY))
1254  format = 1; /* BINARY */
1255  }
1256  }
1257  PortalSetResultFormat(portal, 1, &format);
1258 
1259  /*
1260  * Now we can create the destination receiver object.
1261  */
1262  receiver = CreateDestReceiver(dest);
1263  if (dest == DestRemote)
1264  SetRemoteDestReceiverParams(receiver, portal);
1265 
1266  /*
1267  * Switch back to transaction context for execution.
1268  */
1269  MemoryContextSwitchTo(oldcontext);
1270 
1271  /*
1272  * Run the portal to completion, and then drop it (and the receiver).
1273  */
1274  (void) PortalRun(portal,
1275  FETCH_ALL,
1276  true, /* always top level */
1277  true,
1278  receiver,
1279  receiver,
1280  &qc);
1281 
1282  receiver->rDestroy(receiver);
1283 
1284  PortalDrop(portal, false);
1285 
1286  if (lnext(parsetree_list, parsetree_item) == NULL)
1287  {
1288  /*
1289  * If this is the last parsetree of the query string, close down
1290  * transaction statement before reporting command-complete. This
1291  * is so that any end-of-transaction errors are reported before
1292  * the command-complete message is issued, to avoid confusing
1293  * clients who will expect either a command-complete message or an
1294  * error, not one and then the other. Also, if we're using an
1295  * implicit transaction block, we must close that out first.
1296  */
1297  if (use_implicit_block)
1300  }
1301  else if (IsA(parsetree->stmt, TransactionStmt))
1302  {
1303  /*
1304  * If this was a transaction control statement, commit it. We will
1305  * start a new xact command for the next command.
1306  */
1308  }
1309  else
1310  {
1311  /*
1312  * We had better not see XACT_FLAGS_NEEDIMMEDIATECOMMIT set if
1313  * we're not calling finish_xact_command(). (The implicit
1314  * transaction block should have prevented it from getting set.)
1315  */
1317 
1318  /*
1319  * We need a CommandCounterIncrement after every query, except
1320  * those that start or end a transaction block.
1321  */
1323 
1324  /*
1325  * Disable statement timeout between queries of a multi-query
1326  * string, so that the timeout applies separately to each query.
1327  * (Our next loop iteration will start a fresh timeout.)
1328  */
1330  }
1331 
1332  /*
1333  * Tell client that we're done with this query. Note we emit exactly
1334  * one EndCommand report for each raw parsetree, thus one for each SQL
1335  * command the client sent, regardless of rewriting. (But a command
1336  * aborted by error will not send an EndCommand report at all.)
1337  */
1338  EndCommand(&qc, dest, false);
1339 
1340  /* Now we may drop the per-parsetree context, if one was created. */
1341  if (per_parsetree_context)
1342  MemoryContextDelete(per_parsetree_context);
1343  } /* end loop over parsetrees */
1344 
1345  /*
1346  * Close down transaction statement, if one is open. (This will only do
1347  * something if the parsetree list was empty; otherwise the last loop
1348  * iteration already did it.)
1349  */
1351 
1352  /*
1353  * If there were no parsetrees, return EmptyQueryResponse message.
1354  */
1355  if (!parsetree_list)
1356  NullCommand(dest);
1357 
1358  /*
1359  * Emit duration logging if appropriate.
1360  */
1361  switch (check_log_duration(msec_str, was_logged))
1362  {
1363  case 1:
1364  ereport(LOG,
1365  (errmsg("duration: %s ms", msec_str),
1366  errhidestmt(true)));
1367  break;
1368  case 2:
1369  ereport(LOG,
1370  (errmsg("duration: %s ms statement: %s",
1371  msec_str, query_string),
1372  errhidestmt(true),
1373  errdetail_execute(parsetree_list)));
1374  break;
1375  }
1376 
1377  if (save_log_statement_stats)
1378  ShowUsage("QUERY STATISTICS");
1379 
1380  TRACE_POSTGRESQL_QUERY_DONE(query_string);
1381 
1382  debug_query_string = NULL;
1383 }
1384 
1385 /*
1386  * exec_parse_message
1387  *
1388  * Execute a "Parse" protocol message.
1389  */
1390 static void
1391 exec_parse_message(const char *query_string, /* string to execute */
1392  const char *stmt_name, /* name for prepared stmt */
1393  Oid *paramTypes, /* parameter types */
1394  int numParams) /* number of parameters */
1395 {
1396  MemoryContext unnamed_stmt_context = NULL;
1397  MemoryContext oldcontext;
1398  List *parsetree_list;
1399  RawStmt *raw_parse_tree;
1400  List *querytree_list;
1401  CachedPlanSource *psrc;
1402  bool is_named;
1403  bool save_log_statement_stats = log_statement_stats;
1404  char msec_str[32];
1405 
1406  /*
1407  * Report query to various monitoring facilities.
1408  */
1409  debug_query_string = query_string;
1410 
1411  pgstat_report_activity(STATE_RUNNING, query_string);
1412 
1413  set_ps_display("PARSE");
1414 
1415  if (save_log_statement_stats)
1416  ResetUsage();
1417 
1418  ereport(DEBUG2,
1419  (errmsg_internal("parse %s: %s",
1420  *stmt_name ? stmt_name : "<unnamed>",
1421  query_string)));
1422 
1423  /*
1424  * Start up a transaction command so we can run parse analysis etc. (Note
1425  * that this will normally change current memory context.) Nothing happens
1426  * if we are already in one. This also arms the statement timeout if
1427  * necessary.
1428  */
1430 
1431  /*
1432  * Switch to appropriate context for constructing parsetrees.
1433  *
1434  * We have two strategies depending on whether the prepared statement is
1435  * named or not. For a named prepared statement, we do parsing in
1436  * MessageContext and copy the finished trees into the prepared
1437  * statement's plancache entry; then the reset of MessageContext releases
1438  * temporary space used by parsing and rewriting. For an unnamed prepared
1439  * statement, we assume the statement isn't going to hang around long, so
1440  * getting rid of temp space quickly is probably not worth the costs of
1441  * copying parse trees. So in this case, we create the plancache entry's
1442  * query_context here, and do all the parsing work therein.
1443  */
1444  is_named = (stmt_name[0] != '\0');
1445  if (is_named)
1446  {
1447  /* Named prepared statement --- parse in MessageContext */
1448  oldcontext = MemoryContextSwitchTo(MessageContext);
1449  }
1450  else
1451  {
1452  /* Unnamed prepared statement --- release any prior unnamed stmt */
1454  /* Create context for parsing */
1455  unnamed_stmt_context =
1457  "unnamed prepared statement",
1459  oldcontext = MemoryContextSwitchTo(unnamed_stmt_context);
1460  }
1461 
1462  /*
1463  * Do basic parsing of the query or queries (this should be safe even if
1464  * we are in aborted transaction state!)
1465  */
1466  parsetree_list = pg_parse_query(query_string);
1467 
1468  /*
1469  * We only allow a single user statement in a prepared statement. This is
1470  * mainly to keep the protocol simple --- otherwise we'd need to worry
1471  * about multiple result tupdescs and things like that.
1472  */
1473  if (list_length(parsetree_list) > 1)
1474  ereport(ERROR,
1475  (errcode(ERRCODE_SYNTAX_ERROR),
1476  errmsg("cannot insert multiple commands into a prepared statement")));
1477 
1478  if (parsetree_list != NIL)
1479  {
1480  bool snapshot_set = false;
1481 
1482  raw_parse_tree = linitial_node(RawStmt, parsetree_list);
1483 
1484  /*
1485  * If we are in an aborted transaction, reject all commands except
1486  * COMMIT/ROLLBACK. It is important that this test occur before we
1487  * try to do parse analysis, rewrite, or planning, since all those
1488  * phases try to do database accesses, which may fail in abort state.
1489  * (It might be safe to allow some additional utility commands in this
1490  * state, but not many...)
1491  */
1493  !IsTransactionExitStmt(raw_parse_tree->stmt))
1494  ereport(ERROR,
1495  (errcode(ERRCODE_IN_FAILED_SQL_TRANSACTION),
1496  errmsg("current transaction is aborted, "
1497  "commands ignored until end of transaction block"),
1498  errdetail_abort()));
1499 
1500  /*
1501  * Create the CachedPlanSource before we do parse analysis, since it
1502  * needs to see the unmodified raw parse tree.
1503  */
1504  psrc = CreateCachedPlan(raw_parse_tree, query_string,
1505  CreateCommandTag(raw_parse_tree->stmt));
1506 
1507  /*
1508  * Set up a snapshot if parse analysis will need one.
1509  */
1510  if (analyze_requires_snapshot(raw_parse_tree))
1511  {
1513  snapshot_set = true;
1514  }
1515 
1516  /*
1517  * Analyze and rewrite the query. Note that the originally specified
1518  * parameter set is not required to be complete, so we have to use
1519  * pg_analyze_and_rewrite_varparams().
1520  */
1521  querytree_list = pg_analyze_and_rewrite_varparams(raw_parse_tree,
1522  query_string,
1523  &paramTypes,
1524  &numParams,
1525  NULL);
1526 
1527  /* Done with the snapshot used for parsing */
1528  if (snapshot_set)
1530  }
1531  else
1532  {
1533  /* Empty input string. This is legal. */
1534  raw_parse_tree = NULL;
1535  psrc = CreateCachedPlan(raw_parse_tree, query_string,
1536  CMDTAG_UNKNOWN);
1537  querytree_list = NIL;
1538  }
1539 
1540  /*
1541  * CachedPlanSource must be a direct child of MessageContext before we
1542  * reparent unnamed_stmt_context under it, else we have a disconnected
1543  * circular subgraph. Klugy, but less so than flipping contexts even more
1544  * above.
1545  */
1546  if (unnamed_stmt_context)
1548 
1549  /* Finish filling in the CachedPlanSource */
1550  CompleteCachedPlan(psrc,
1551  querytree_list,
1552  unnamed_stmt_context,
1553  paramTypes,
1554  numParams,
1555  NULL,
1556  NULL,
1557  CURSOR_OPT_PARALLEL_OK, /* allow parallel mode */
1558  true); /* fixed result */
1559 
1560  /* If we got a cancel signal during analysis, quit */
1562 
1563  if (is_named)
1564  {
1565  /*
1566  * Store the query as a prepared statement.
1567  */
1568  StorePreparedStatement(stmt_name, psrc, false);
1569  }
1570  else
1571  {
1572  /*
1573  * We just save the CachedPlanSource into unnamed_stmt_psrc.
1574  */
1575  SaveCachedPlan(psrc);
1576  unnamed_stmt_psrc = psrc;
1577  }
1578 
1579  MemoryContextSwitchTo(oldcontext);
1580 
1581  /*
1582  * We do NOT close the open transaction command here; that only happens
1583  * when the client sends Sync. Instead, do CommandCounterIncrement just
1584  * in case something happened during parse/plan.
1585  */
1587 
1588  /*
1589  * Send ParseComplete.
1590  */
1593 
1594  /*
1595  * Emit duration logging if appropriate.
1596  */
1597  switch (check_log_duration(msec_str, false))
1598  {
1599  case 1:
1600  ereport(LOG,
1601  (errmsg("duration: %s ms", msec_str),
1602  errhidestmt(true)));
1603  break;
1604  case 2:
1605  ereport(LOG,
1606  (errmsg("duration: %s ms parse %s: %s",
1607  msec_str,
1608  *stmt_name ? stmt_name : "<unnamed>",
1609  query_string),
1610  errhidestmt(true)));
1611  break;
1612  }
1613 
1614  if (save_log_statement_stats)
1615  ShowUsage("PARSE MESSAGE STATISTICS");
1616 
1617  debug_query_string = NULL;
1618 }
1619 
1620 /*
1621  * exec_bind_message
1622  *
1623  * Process a "Bind" message to create a portal from a prepared statement
1624  */
1625 static void
1627 {
1628  const char *portal_name;
1629  const char *stmt_name;
1630  int numPFormats;
1631  int16 *pformats = NULL;
1632  int numParams;
1633  int numRFormats;
1634  int16 *rformats = NULL;
1635  CachedPlanSource *psrc;
1636  CachedPlan *cplan;
1637  Portal portal;
1638  char *query_string;
1639  char *saved_stmt_name;
1640  ParamListInfo params;
1641  MemoryContext oldContext;
1642  bool save_log_statement_stats = log_statement_stats;
1643  bool snapshot_set = false;
1644  char msec_str[32];
1645  ParamsErrorCbData params_data;
1646  ErrorContextCallback params_errcxt;
1647 
1648  /* Get the fixed part of the message */
1649  portal_name = pq_getmsgstring(input_message);
1650  stmt_name = pq_getmsgstring(input_message);
1651 
1652  ereport(DEBUG2,
1653  (errmsg_internal("bind %s to %s",
1654  *portal_name ? portal_name : "<unnamed>",
1655  *stmt_name ? stmt_name : "<unnamed>")));
1656 
1657  /* Find prepared statement */
1658  if (stmt_name[0] != '\0')
1659  {
1660  PreparedStatement *pstmt;
1661 
1662  pstmt = FetchPreparedStatement(stmt_name, true);
1663  psrc = pstmt->plansource;
1664  }
1665  else
1666  {
1667  /* special-case the unnamed statement */
1668  psrc = unnamed_stmt_psrc;
1669  if (!psrc)
1670  ereport(ERROR,
1671  (errcode(ERRCODE_UNDEFINED_PSTATEMENT),
1672  errmsg("unnamed prepared statement does not exist")));
1673  }
1674 
1675  /*
1676  * Report query to various monitoring facilities.
1677  */
1679 
1681 
1682  set_ps_display("BIND");
1683 
1684  if (save_log_statement_stats)
1685  ResetUsage();
1686 
1687  /*
1688  * Start up a transaction command so we can call functions etc. (Note that
1689  * this will normally change current memory context.) Nothing happens if
1690  * we are already in one. This also arms the statement timeout if
1691  * necessary.
1692  */
1694 
1695  /* Switch back to message context */
1697 
1698  /* Get the parameter format codes */
1699  numPFormats = pq_getmsgint(input_message, 2);
1700  if (numPFormats > 0)
1701  {
1702  pformats = palloc_array(int16, numPFormats);
1703  for (int i = 0; i < numPFormats; i++)
1704  pformats[i] = pq_getmsgint(input_message, 2);
1705  }
1706 
1707  /* Get the parameter value count */
1708  numParams = pq_getmsgint(input_message, 2);
1709 
1710  if (numPFormats > 1 && numPFormats != numParams)
1711  ereport(ERROR,
1712  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1713  errmsg("bind message has %d parameter formats but %d parameters",
1714  numPFormats, numParams)));
1715 
1716  if (numParams != psrc->num_params)
1717  ereport(ERROR,
1718  (errcode(ERRCODE_PROTOCOL_VIOLATION),
1719  errmsg("bind message supplies %d parameters, but prepared statement \"%s\" requires %d",
1720  numParams, stmt_name, psrc->num_params)));
1721 
1722  /*
1723  * If we are in aborted transaction state, the only portals we can
1724  * actually run are those containing COMMIT or ROLLBACK commands. We
1725  * disallow binding anything else to avoid problems with infrastructure
1726  * that expects to run inside a valid transaction. We also disallow
1727  * binding any parameters, since we can't risk calling user-defined I/O
1728  * functions.
1729  */
1731  (!(psrc->raw_parse_tree &&
1733  numParams != 0))
1734  ereport(ERROR,
1735  (errcode(ERRCODE_IN_FAILED_SQL_TRANSACTION),
1736  errmsg("current transaction is aborted, "
1737  "commands ignored until end of transaction block"),
1738  errdetail_abort()));
1739 
1740  /*
1741  * Create the portal. Allow silent replacement of an existing portal only
1742  * if the unnamed portal is specified.
1743  */
1744  if (portal_name[0] == '\0')
1745  portal = CreatePortal(portal_name, true, true);
1746  else
1747  portal = CreatePortal(portal_name, false, false);
1748 
1749  /*
1750  * Prepare to copy stuff into the portal's memory context. We do all this
1751  * copying first, because it could possibly fail (out-of-memory) and we
1752  * don't want a failure to occur between GetCachedPlan and
1753  * PortalDefineQuery; that would result in leaking our plancache refcount.
1754  */
1755  oldContext = MemoryContextSwitchTo(portal->portalContext);
1756 
1757  /* Copy the plan's query string into the portal */
1758  query_string = pstrdup(psrc->query_string);
1759 
1760  /* Likewise make a copy of the statement name, unless it's unnamed */
1761  if (stmt_name[0])
1762  saved_stmt_name = pstrdup(stmt_name);
1763  else
1764  saved_stmt_name = NULL;
1765 
1766  /*
1767  * Set a snapshot if we have parameters to fetch (since the input
1768  * functions might need it) or the query isn't a utility command (and
1769  * hence could require redoing parse analysis and planning). We keep the
1770  * snapshot active till we're done, so that plancache.c doesn't have to
1771  * take new ones.
1772  */
1773  if (numParams > 0 ||
1774  (psrc->raw_parse_tree &&
1776  {
1778  snapshot_set = true;
1779  }
1780 
1781  /*
1782  * Fetch parameters, if any, and store in the portal's memory context.
1783  */
1784  if (numParams > 0)
1785  {
1786  char **knownTextValues = NULL; /* allocate on first use */
1787  BindParamCbData one_param_data;
1788 
1789  /*
1790  * Set up an error callback so that if there's an error in this phase,
1791  * we can report the specific parameter causing the problem.
1792  */
1793  one_param_data.portalName = portal->name;
1794  one_param_data.paramno = -1;
1795  one_param_data.paramval = NULL;
1796  params_errcxt.previous = error_context_stack;
1797  params_errcxt.callback = bind_param_error_callback;
1798  params_errcxt.arg = (void *) &one_param_data;
1799  error_context_stack = &params_errcxt;
1800 
1801  params = makeParamList(numParams);
1802 
1803  for (int paramno = 0; paramno < numParams; paramno++)
1804  {
1805  Oid ptype = psrc->param_types[paramno];
1806  int32 plength;
1807  Datum pval;
1808  bool isNull;
1809  StringInfoData pbuf;
1810  char csave;
1811  int16 pformat;
1812 
1813  one_param_data.paramno = paramno;
1814  one_param_data.paramval = NULL;
1815 
1816  plength = pq_getmsgint(input_message, 4);
1817  isNull = (plength == -1);
1818 
1819  if (!isNull)
1820  {
1821  char *pvalue;
1822 
1823  /*
1824  * Rather than copying data around, we just initialize a
1825  * StringInfo pointing to the correct portion of the message
1826  * buffer. We assume we can scribble on the message buffer to
1827  * add a trailing NUL which is required for the input function
1828  * call.
1829  */
1830  pvalue = unconstify(char *, pq_getmsgbytes(input_message, plength));
1831  csave = pvalue[plength];
1832  pvalue[plength] = '\0';
1833  initReadOnlyStringInfo(&pbuf, pvalue, plength);
1834  }
1835  else
1836  {
1837  pbuf.data = NULL; /* keep compiler quiet */
1838  csave = 0;
1839  }
1840 
1841  if (numPFormats > 1)
1842  pformat = pformats[paramno];
1843  else if (numPFormats > 0)
1844  pformat = pformats[0];
1845  else
1846  pformat = 0; /* default = text */
1847 
1848  if (pformat == 0) /* text mode */
1849  {
1850  Oid typinput;
1851  Oid typioparam;
1852  char *pstring;
1853 
1854  getTypeInputInfo(ptype, &typinput, &typioparam);
1855 
1856  /*
1857  * We have to do encoding conversion before calling the
1858  * typinput routine.
1859  */
1860  if (isNull)
1861  pstring = NULL;
1862  else
1863  pstring = pg_client_to_server(pbuf.data, plength);
1864 
1865  /* Now we can log the input string in case of error */
1866  one_param_data.paramval = pstring;
1867 
1868  pval = OidInputFunctionCall(typinput, pstring, typioparam, -1);
1869 
1870  one_param_data.paramval = NULL;
1871 
1872  /*
1873  * If we might need to log parameters later, save a copy of
1874  * the converted string in MessageContext; then free the
1875  * result of encoding conversion, if any was done.
1876  */
1877  if (pstring)
1878  {
1880  {
1881  MemoryContext oldcxt;
1882 
1884 
1885  if (knownTextValues == NULL)
1886  knownTextValues = palloc0_array(char *, numParams);
1887 
1889  knownTextValues[paramno] = pstrdup(pstring);
1890  else
1891  {
1892  /*
1893  * We can trim the saved string, knowing that we
1894  * won't print all of it. But we must copy at
1895  * least two more full characters than
1896  * BuildParamLogString wants to use; otherwise it
1897  * might fail to include the trailing ellipsis.
1898  */
1899  knownTextValues[paramno] =
1900  pnstrdup(pstring,
1902  + 2 * MAX_MULTIBYTE_CHAR_LEN);
1903  }
1904 
1905  MemoryContextSwitchTo(oldcxt);
1906  }
1907  if (pstring != pbuf.data)
1908  pfree(pstring);
1909  }
1910  }
1911  else if (pformat == 1) /* binary mode */
1912  {
1913  Oid typreceive;
1914  Oid typioparam;
1915  StringInfo bufptr;
1916 
1917  /*
1918  * Call the parameter type's binary input converter
1919  */
1920  getTypeBinaryInputInfo(ptype, &typreceive, &typioparam);
1921 
1922  if (isNull)
1923  bufptr = NULL;
1924  else
1925  bufptr = &pbuf;
1926 
1927  pval = OidReceiveFunctionCall(typreceive, bufptr, typioparam, -1);
1928 
1929  /* Trouble if it didn't eat the whole buffer */
1930  if (!isNull && pbuf.cursor != pbuf.len)
1931  ereport(ERROR,
1932  (errcode(ERRCODE_INVALID_BINARY_REPRESENTATION),
1933  errmsg("incorrect binary data format in bind parameter %d",
1934  paramno + 1)));
1935  }
1936  else
1937  {
1938  ereport(ERROR,
1939  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1940  errmsg("unsupported format code: %d",
1941  pformat)));
1942  pval = 0; /* keep compiler quiet */
1943  }
1944 
1945  /* Restore message buffer contents */
1946  if (!isNull)
1947  pbuf.data[plength] = csave;
1948 
1949  params->params[paramno].value = pval;
1950  params->params[paramno].isnull = isNull;
1951 
1952  /*
1953  * We mark the params as CONST. This ensures that any custom plan
1954  * makes full use of the parameter values.
1955  */
1956  params->params[paramno].pflags = PARAM_FLAG_CONST;
1957  params->params[paramno].ptype = ptype;
1958  }
1959 
1960  /* Pop the per-parameter error callback */
1962 
1963  /*
1964  * Once all parameters have been received, prepare for printing them
1965  * in future errors, if configured to do so. (This is saved in the
1966  * portal, so that they'll appear when the query is executed later.)
1967  */
1969  params->paramValuesStr =
1970  BuildParamLogString(params,
1971  knownTextValues,
1973  }
1974  else
1975  params = NULL;
1976 
1977  /* Done storing stuff in portal's context */
1978  MemoryContextSwitchTo(oldContext);
1979 
1980  /*
1981  * Set up another error callback so that all the parameters are logged if
1982  * we get an error during the rest of the BIND processing.
1983  */
1984  params_data.portalName = portal->name;
1985  params_data.params = params;
1986  params_errcxt.previous = error_context_stack;
1987  params_errcxt.callback = ParamsErrorCallback;
1988  params_errcxt.arg = (void *) &params_data;
1989  error_context_stack = &params_errcxt;
1990 
1991  /* Get the result format codes */
1992  numRFormats = pq_getmsgint(input_message, 2);
1993  if (numRFormats > 0)
1994  {
1995  rformats = palloc_array(int16, numRFormats);
1996  for (int i = 0; i < numRFormats; i++)
1997  rformats[i] = pq_getmsgint(input_message, 2);
1998  }
1999 
2000  pq_getmsgend(input_message);
2001 
2002  /*
2003  * Obtain a plan from the CachedPlanSource. Any cruft from (re)planning
2004  * will be generated in MessageContext. The plan refcount will be
2005  * assigned to the Portal, so it will be released at portal destruction.
2006  */
2007  cplan = GetCachedPlan(psrc, params, NULL, NULL);
2008 
2009  /*
2010  * Now we can define the portal.
2011  *
2012  * DO NOT put any code that could possibly throw an error between the
2013  * above GetCachedPlan call and here.
2014  */
2015  PortalDefineQuery(portal,
2016  saved_stmt_name,
2017  query_string,
2018  psrc->commandTag,
2019  cplan->stmt_list,
2020  cplan);
2021 
2022  /* Done with the snapshot used for parameter I/O and parsing/planning */
2023  if (snapshot_set)
2025 
2026  /*
2027  * And we're ready to start portal execution.
2028  */
2029  PortalStart(portal, params, 0, InvalidSnapshot);
2030 
2031  /*
2032  * Apply the result format requests to the portal.
2033  */
2034  PortalSetResultFormat(portal, numRFormats, rformats);
2035 
2036  /*
2037  * Done binding; remove the parameters error callback. Entries emitted
2038  * later determine independently whether to log the parameters or not.
2039  */
2041 
2042  /*
2043  * Send BindComplete.
2044  */
2047 
2048  /*
2049  * Emit duration logging if appropriate.
2050  */
2051  switch (check_log_duration(msec_str, false))
2052  {
2053  case 1:
2054  ereport(LOG,
2055  (errmsg("duration: %s ms", msec_str),
2056  errhidestmt(true)));
2057  break;
2058  case 2:
2059  ereport(LOG,
2060  (errmsg("duration: %s ms bind %s%s%s: %s",
2061  msec_str,
2062  *stmt_name ? stmt_name : "<unnamed>",
2063  *portal_name ? "/" : "",
2064  *portal_name ? portal_name : "",
2065  psrc->query_string),
2066  errhidestmt(true),
2067  errdetail_params(params)));
2068  break;
2069  }
2070 
2071  if (save_log_statement_stats)
2072  ShowUsage("BIND MESSAGE STATISTICS");
2073 
2075 
2076  debug_query_string = NULL;
2077 }
2078 
2079 /*
2080  * exec_execute_message
2081  *
2082  * Process an "Execute" message for a portal
2083  */
2084 static void
2085 exec_execute_message(const char *portal_name, long max_rows)
2086 {
2087  CommandDest dest;
2088  DestReceiver *receiver;
2089  Portal portal;
2090  bool completed;
2091  QueryCompletion qc;
2092  const char *sourceText;
2093  const char *prepStmtName;
2094  ParamListInfo portalParams;
2095  bool save_log_statement_stats = log_statement_stats;
2096  bool is_xact_command;
2097  bool execute_is_fetch;
2098  bool was_logged = false;
2099  char msec_str[32];
2100  ParamsErrorCbData params_data;
2101  ErrorContextCallback params_errcxt;
2102  const char *cmdtagname;
2103  size_t cmdtaglen;
2104 
2105  /* Adjust destination to tell printtup.c what to do */
2107  if (dest == DestRemote)
2109 
2110  portal = GetPortalByName(portal_name);
2111  if (!PortalIsValid(portal))
2112  ereport(ERROR,
2113  (errcode(ERRCODE_UNDEFINED_CURSOR),
2114  errmsg("portal \"%s\" does not exist", portal_name)));
2115 
2116  /*
2117  * If the original query was a null string, just return
2118  * EmptyQueryResponse.
2119  */
2120  if (portal->commandTag == CMDTAG_UNKNOWN)
2121  {
2122  Assert(portal->stmts == NIL);
2123  NullCommand(dest);
2124  return;
2125  }
2126 
2127  /* Does the portal contain a transaction command? */
2128  is_xact_command = IsTransactionStmtList(portal->stmts);
2129 
2130  /*
2131  * We must copy the sourceText and prepStmtName into MessageContext in
2132  * case the portal is destroyed during finish_xact_command. We do not
2133  * make a copy of the portalParams though, preferring to just not print
2134  * them in that case.
2135  */
2136  sourceText = pstrdup(portal->sourceText);
2137  if (portal->prepStmtName)
2138  prepStmtName = pstrdup(portal->prepStmtName);
2139  else
2140  prepStmtName = "<unnamed>";
2141  portalParams = portal->portalParams;
2142 
2143  /*
2144  * Report query to various monitoring facilities.
2145  */
2146  debug_query_string = sourceText;
2147 
2149 
2150  cmdtagname = GetCommandTagNameAndLen(portal->commandTag, &cmdtaglen);
2151 
2152  set_ps_display_with_len(cmdtagname, cmdtaglen);
2153 
2154  if (save_log_statement_stats)
2155  ResetUsage();
2156 
2157  BeginCommand(portal->commandTag, dest);
2158 
2159  /*
2160  * Create dest receiver in MessageContext (we don't want it in transaction
2161  * context, because that may get deleted if portal contains VACUUM).
2162  */
2163  receiver = CreateDestReceiver(dest);
2164  if (dest == DestRemoteExecute)
2165  SetRemoteDestReceiverParams(receiver, portal);
2166 
2167  /*
2168  * Ensure we are in a transaction command (this should normally be the
2169  * case already due to prior BIND).
2170  */
2172 
2173  /*
2174  * If we re-issue an Execute protocol request against an existing portal,
2175  * then we are only fetching more rows rather than completely re-executing
2176  * the query from the start. atStart is never reset for a v3 portal, so we
2177  * are safe to use this check.
2178  */
2179  execute_is_fetch = !portal->atStart;
2180 
2181  /* Log immediately if dictated by log_statement */
2182  if (check_log_statement(portal->stmts))
2183  {
2184  ereport(LOG,
2185  (errmsg("%s %s%s%s: %s",
2186  execute_is_fetch ?
2187  _("execute fetch from") :
2188  _("execute"),
2189  prepStmtName,
2190  *portal_name ? "/" : "",
2191  *portal_name ? portal_name : "",
2192  sourceText),
2193  errhidestmt(true),
2194  errdetail_params(portalParams)));
2195  was_logged = true;
2196  }
2197 
2198  /*
2199  * If we are in aborted transaction state, the only portals we can
2200  * actually run are those containing COMMIT or ROLLBACK commands.
2201  */
2203  !IsTransactionExitStmtList(portal->stmts))
2204  ereport(ERROR,
2205  (errcode(ERRCODE_IN_FAILED_SQL_TRANSACTION),
2206  errmsg("current transaction is aborted, "
2207  "commands ignored until end of transaction block"),
2208  errdetail_abort()));
2209 
2210  /* Check for cancel signal before we start execution */
2212 
2213  /*
2214  * Okay to run the portal. Set the error callback so that parameters are
2215  * logged. The parameters must have been saved during the bind phase.
2216  */
2217  params_data.portalName = portal->name;
2218  params_data.params = portalParams;
2219  params_errcxt.previous = error_context_stack;
2220  params_errcxt.callback = ParamsErrorCallback;
2221  params_errcxt.arg = (void *) &params_data;
2222  error_context_stack = &params_errcxt;
2223 
2224  if (max_rows <= 0)
2225  max_rows = FETCH_ALL;
2226 
2227  completed = PortalRun(portal,
2228  max_rows,
2229  true, /* always top level */
2230  !execute_is_fetch && max_rows == FETCH_ALL,
2231  receiver,
2232  receiver,
2233  &qc);
2234 
2235  receiver->rDestroy(receiver);
2236 
2237  /* Done executing; remove the params error callback */
2239 
2240  if (completed)
2241  {
2242  if (is_xact_command || (MyXactFlags & XACT_FLAGS_NEEDIMMEDIATECOMMIT))
2243  {
2244  /*
2245  * If this was a transaction control statement, commit it. We
2246  * will start a new xact command for the next command (if any).
2247  * Likewise if the statement required immediate commit. Without
2248  * this provision, we wouldn't force commit until Sync is
2249  * received, which creates a hazard if the client tries to
2250  * pipeline immediate-commit statements.
2251  */
2253 
2254  /*
2255  * These commands typically don't have any parameters, and even if
2256  * one did we couldn't print them now because the storage went
2257  * away during finish_xact_command. So pretend there were none.
2258  */
2259  portalParams = NULL;
2260  }
2261  else
2262  {
2263  /*
2264  * We need a CommandCounterIncrement after every query, except
2265  * those that start or end a transaction block.
2266  */
2268 
2269  /*
2270  * Set XACT_FLAGS_PIPELINING whenever we complete an Execute
2271  * message without immediately committing the transaction.
2272  */
2274 
2275  /*
2276  * Disable statement timeout whenever we complete an Execute
2277  * message. The next protocol message will start a fresh timeout.
2278  */
2280  }
2281 
2282  /* Send appropriate CommandComplete to client */
2283  EndCommand(&qc, dest, false);
2284  }
2285  else
2286  {
2287  /* Portal run not complete, so send PortalSuspended */
2290 
2291  /*
2292  * Set XACT_FLAGS_PIPELINING whenever we suspend an Execute message,
2293  * too.
2294  */
2296  }
2297 
2298  /*
2299  * Emit duration logging if appropriate.
2300  */
2301  switch (check_log_duration(msec_str, was_logged))
2302  {
2303  case 1:
2304  ereport(LOG,
2305  (errmsg("duration: %s ms", msec_str),
2306  errhidestmt(true)));
2307  break;
2308  case 2:
2309  ereport(LOG,
2310  (errmsg("duration: %s ms %s %s%s%s: %s",
2311  msec_str,
2312  execute_is_fetch ?
2313  _("execute fetch from") :
2314  _("execute"),
2315  prepStmtName,
2316  *portal_name ? "/" : "",
2317  *portal_name ? portal_name : "",
2318  sourceText),
2319  errhidestmt(true),
2320  errdetail_params(portalParams)));
2321  break;
2322  }
2323 
2324  if (save_log_statement_stats)
2325  ShowUsage("EXECUTE MESSAGE STATISTICS");
2326 
2328 
2329  debug_query_string = NULL;
2330 }
2331 
2332 /*
2333  * check_log_statement
2334  * Determine whether command should be logged because of log_statement
2335  *
2336  * stmt_list can be either raw grammar output or a list of planned
2337  * statements
2338  */
2339 static bool
2341 {
2342  ListCell *stmt_item;
2343 
2344  if (log_statement == LOGSTMT_NONE)
2345  return false;
2346  if (log_statement == LOGSTMT_ALL)
2347  return true;
2348 
2349  /* Else we have to inspect the statement(s) to see whether to log */
2350  foreach(stmt_item, stmt_list)
2351  {
2352  Node *stmt = (Node *) lfirst(stmt_item);
2353 
2355  return true;
2356  }
2357 
2358  return false;
2359 }
2360 
2361 /*
2362  * check_log_duration
2363  * Determine whether current command's duration should be logged
2364  * We also check if this statement in this transaction must be logged
2365  * (regardless of its duration).
2366  *
2367  * Returns:
2368  * 0 if no logging is needed
2369  * 1 if just the duration should be logged
2370  * 2 if duration and query details should be logged
2371  *
2372  * If logging is needed, the duration in msec is formatted into msec_str[],
2373  * which must be a 32-byte buffer.
2374  *
2375  * was_logged should be true if caller already logged query details (this
2376  * essentially prevents 2 from being returned).
2377  */
2378 int
2379 check_log_duration(char *msec_str, bool was_logged)
2380 {
2381  if (log_duration || log_min_duration_sample >= 0 ||
2383  {
2384  long secs;
2385  int usecs;
2386  int msecs;
2387  bool exceeded_duration;
2388  bool exceeded_sample_duration;
2389  bool in_sample = false;
2390 
2393  &secs, &usecs);
2394  msecs = usecs / 1000;
2395 
2396  /*
2397  * This odd-looking test for log_min_duration_* being exceeded is
2398  * designed to avoid integer overflow with very long durations: don't
2399  * compute secs * 1000 until we've verified it will fit in int.
2400  */
2401  exceeded_duration = (log_min_duration_statement == 0 ||
2403  (secs > log_min_duration_statement / 1000 ||
2404  secs * 1000 + msecs >= log_min_duration_statement)));
2405 
2406  exceeded_sample_duration = (log_min_duration_sample == 0 ||
2407  (log_min_duration_sample > 0 &&
2408  (secs > log_min_duration_sample / 1000 ||
2409  secs * 1000 + msecs >= log_min_duration_sample)));
2410 
2411  /*
2412  * Do not log if log_statement_sample_rate = 0. Log a sample if
2413  * log_statement_sample_rate <= 1 and avoid unnecessary PRNG call if
2414  * log_statement_sample_rate = 1.
2415  */
2416  if (exceeded_sample_duration)
2417  in_sample = log_statement_sample_rate != 0 &&
2418  (log_statement_sample_rate == 1 ||
2420 
2421  if (exceeded_duration || in_sample || log_duration || xact_is_sampled)
2422  {
2423  snprintf(msec_str, 32, "%ld.%03d",
2424  secs * 1000 + msecs, usecs % 1000);
2425  if ((exceeded_duration || in_sample || xact_is_sampled) && !was_logged)
2426  return 2;
2427  else
2428  return 1;
2429  }
2430  }
2431 
2432  return 0;
2433 }
2434 
2435 /*
2436  * errdetail_execute
2437  *
2438  * Add an errdetail() line showing the query referenced by an EXECUTE, if any.
2439  * The argument is the raw parsetree list.
2440  */
2441 static int
2442 errdetail_execute(List *raw_parsetree_list)
2443 {
2444  ListCell *parsetree_item;
2445 
2446  foreach(parsetree_item, raw_parsetree_list)
2447  {
2448  RawStmt *parsetree = lfirst_node(RawStmt, parsetree_item);
2449 
2450  if (IsA(parsetree->stmt, ExecuteStmt))
2451  {
2452  ExecuteStmt *stmt = (ExecuteStmt *) parsetree->stmt;
2453  PreparedStatement *pstmt;
2454 
2455  pstmt = FetchPreparedStatement(stmt->name, false);
2456  if (pstmt)
2457  {
2458  errdetail("prepare: %s", pstmt->plansource->query_string);
2459  return 0;
2460  }
2461  }
2462  }
2463 
2464  return 0;
2465 }
2466 
2467 /*
2468  * errdetail_params
2469  *
2470  * Add an errdetail() line showing bind-parameter data, if available.
2471  * Note that this is only used for statement logging, so it is controlled
2472  * by log_parameter_max_length not log_parameter_max_length_on_error.
2473  */
2474 static int
2476 {
2477  if (params && params->numParams > 0 && log_parameter_max_length != 0)
2478  {
2479  char *str;
2480 
2482  if (str && str[0] != '\0')
2483  errdetail("Parameters: %s", str);
2484  }
2485 
2486  return 0;
2487 }
2488 
2489 /*
2490  * errdetail_abort
2491  *
2492  * Add an errdetail() line showing abort reason, if any.
2493  */
2494 static int
2496 {
2498  errdetail("Abort reason: recovery conflict");
2499 
2500  return 0;
2501 }
2502 
2503 /*
2504  * errdetail_recovery_conflict
2505  *
2506  * Add an errdetail() line showing conflict source.
2507  */
2508 static int
2510 {
2511  switch (reason)
2512  {
2514  errdetail("User was holding shared buffer pin for too long.");
2515  break;
2517  errdetail("User was holding a relation lock for too long.");
2518  break;
2520  errdetail("User was or might have been using tablespace that must be dropped.");
2521  break;
2523  errdetail("User query might have needed to see row versions that must be removed.");
2524  break;
2526  errdetail("User was using a logical replication slot that must be invalidated.");
2527  break;
2529  errdetail("User transaction caused buffer deadlock with recovery.");
2530  break;
2532  errdetail("User was connected to a database that must be dropped.");
2533  break;
2534  default:
2535  break;
2536  /* no errdetail */
2537  }
2538 
2539  return 0;
2540 }
2541 
2542 /*
2543  * bind_param_error_callback
2544  *
2545  * Error context callback used while parsing parameters in a Bind message
2546  */
2547 static void
2549 {
2552  char *quotedval;
2553 
2554  if (data->paramno < 0)
2555  return;
2556 
2557  /* If we have a textual value, quote it, and trim if necessary */
2558  if (data->paramval)
2559  {
2560  initStringInfo(&buf);
2563  quotedval = buf.data;
2564  }
2565  else
2566  quotedval = NULL;
2567 
2568  if (data->portalName && data->portalName[0] != '\0')
2569  {
2570  if (quotedval)
2571  errcontext("portal \"%s\" parameter $%d = %s",
2572  data->portalName, data->paramno + 1, quotedval);
2573  else
2574  errcontext("portal \"%s\" parameter $%d",
2575  data->portalName, data->paramno + 1);
2576  }
2577  else
2578  {
2579  if (quotedval)
2580  errcontext("unnamed portal parameter $%d = %s",
2581  data->paramno + 1, quotedval);
2582  else
2583  errcontext("unnamed portal parameter $%d",
2584  data->paramno + 1);
2585  }
2586 
2587  if (quotedval)
2588  pfree(quotedval);
2589 }
2590 
2591 /*
2592  * exec_describe_statement_message
2593  *
2594  * Process a "Describe" message for a prepared statement
2595  */
2596 static void
2597 exec_describe_statement_message(const char *stmt_name)
2598 {
2599  CachedPlanSource *psrc;
2600 
2601  /*
2602  * Start up a transaction command. (Note that this will normally change
2603  * current memory context.) Nothing happens if we are already in one.
2604  */
2606 
2607  /* Switch back to message context */
2609 
2610  /* Find prepared statement */
2611  if (stmt_name[0] != '\0')
2612  {
2613  PreparedStatement *pstmt;
2614 
2615  pstmt = FetchPreparedStatement(stmt_name, true);
2616  psrc = pstmt->plansource;
2617  }
2618  else
2619  {
2620  /* special-case the unnamed statement */
2621  psrc = unnamed_stmt_psrc;
2622  if (!psrc)
2623  ereport(ERROR,
2624  (errcode(ERRCODE_UNDEFINED_PSTATEMENT),
2625  errmsg("unnamed prepared statement does not exist")));
2626  }
2627 
2628  /* Prepared statements shouldn't have changeable result descs */
2629  Assert(psrc->fixed_result);
2630 
2631  /*
2632  * If we are in aborted transaction state, we can't run
2633  * SendRowDescriptionMessage(), because that needs catalog accesses.
2634  * Hence, refuse to Describe statements that return data. (We shouldn't
2635  * just refuse all Describes, since that might break the ability of some
2636  * clients to issue COMMIT or ROLLBACK commands, if they use code that
2637  * blindly Describes whatever it does.) We can Describe parameters
2638  * without doing anything dangerous, so we don't restrict that.
2639  */
2641  psrc->resultDesc)
2642  ereport(ERROR,
2643  (errcode(ERRCODE_IN_FAILED_SQL_TRANSACTION),
2644  errmsg("current transaction is aborted, "
2645  "commands ignored until end of transaction block"),
2646  errdetail_abort()));
2647 
2649  return; /* can't actually do anything... */
2650 
2651  /*
2652  * First describe the parameters...
2653  */
2654  pq_beginmessage_reuse(&row_description_buf, 't'); /* parameter description
2655  * message type */
2657 
2658  for (int i = 0; i < psrc->num_params; i++)
2659  {
2660  Oid ptype = psrc->param_types[i];
2661 
2662  pq_sendint32(&row_description_buf, (int) ptype);
2663  }
2665 
2666  /*
2667  * Next send RowDescription or NoData to describe the result...
2668  */
2669  if (psrc->resultDesc)
2670  {
2671  List *tlist;
2672 
2673  /* Get the plan's primary targetlist */
2674  tlist = CachedPlanGetTargetList(psrc, NULL);
2675 
2677  psrc->resultDesc,
2678  tlist,
2679  NULL);
2680  }
2681  else
2683 }
2684 
2685 /*
2686  * exec_describe_portal_message
2687  *
2688  * Process a "Describe" message for a portal
2689  */
2690 static void
2691 exec_describe_portal_message(const char *portal_name)
2692 {
2693  Portal portal;
2694 
2695  /*
2696  * Start up a transaction command. (Note that this will normally change
2697  * current memory context.) Nothing happens if we are already in one.
2698  */
2700 
2701  /* Switch back to message context */
2703 
2704  portal = GetPortalByName(portal_name);
2705  if (!PortalIsValid(portal))
2706  ereport(ERROR,
2707  (errcode(ERRCODE_UNDEFINED_CURSOR),
2708  errmsg("portal \"%s\" does not exist", portal_name)));
2709 
2710  /*
2711  * If we are in aborted transaction state, we can't run
2712  * SendRowDescriptionMessage(), because that needs catalog accesses.
2713  * Hence, refuse to Describe portals that return data. (We shouldn't just
2714  * refuse all Describes, since that might break the ability of some
2715  * clients to issue COMMIT or ROLLBACK commands, if they use code that
2716  * blindly Describes whatever it does.)
2717  */
2719  portal->tupDesc)
2720  ereport(ERROR,
2721  (errcode(ERRCODE_IN_FAILED_SQL_TRANSACTION),
2722  errmsg("current transaction is aborted, "
2723  "commands ignored until end of transaction block"),
2724  errdetail_abort()));
2725 
2727  return; /* can't actually do anything... */
2728 
2729  if (portal->tupDesc)
2731  portal->tupDesc,
2732  FetchPortalTargetList(portal),
2733  portal->formats);
2734  else
2736 }
2737 
2738 
2739 /*
2740  * Convenience routines for starting/committing a single command.
2741  */
2742 static void
2744 {
2745  if (!xact_started)
2746  {
2748 
2749  xact_started = true;
2750  }
2751 
2752  /*
2753  * Start statement timeout if necessary. Note that this'll intentionally
2754  * not reset the clock on an already started timeout, to avoid the timing
2755  * overhead when start_xact_command() is invoked repeatedly, without an
2756  * interceding finish_xact_command() (e.g. parse/bind/execute). If that's
2757  * not desired, the timeout has to be disabled explicitly.
2758  */
2760 
2761  /* Start timeout for checking if the client has gone away if necessary. */
2764  MyProcPort &&
2768 }
2769 
2770 static void
2772 {
2773  /* cancel active statement timeout after each command */
2775 
2776  if (xact_started)
2777  {
2779 
2780 #ifdef MEMORY_CONTEXT_CHECKING
2781  /* Check all memory contexts that weren't freed during commit */
2782  /* (those that were, were checked before being deleted) */
2783  MemoryContextCheck(TopMemoryContext);
2784 #endif
2785 
2786 #ifdef SHOW_MEMORY_STATS
2787  /* Print mem stats after each commit for leak tracking */
2789 #endif
2790 
2791  xact_started = false;
2792  }
2793 }
2794 
2795 
2796 /*
2797  * Convenience routines for checking whether a statement is one of the
2798  * ones that we allow in transaction-aborted state.
2799  */
2800 
2801 /* Test a bare parsetree */
2802 static bool
2804 {
2805  if (parsetree && IsA(parsetree, TransactionStmt))
2806  {
2807  TransactionStmt *stmt = (TransactionStmt *) parsetree;
2808 
2809  if (stmt->kind == TRANS_STMT_COMMIT ||
2810  stmt->kind == TRANS_STMT_PREPARE ||
2811  stmt->kind == TRANS_STMT_ROLLBACK ||
2812  stmt->kind == TRANS_STMT_ROLLBACK_TO)
2813  return true;
2814  }
2815  return false;
2816 }
2817 
2818 /* Test a list that contains PlannedStmt nodes */
2819 static bool
2821 {
2822  if (list_length(pstmts) == 1)
2823  {
2824  PlannedStmt *pstmt = linitial_node(PlannedStmt, pstmts);
2825 
2826  if (pstmt->commandType == CMD_UTILITY &&
2828  return true;
2829  }
2830  return false;
2831 }
2832 
2833 /* Test a list that contains PlannedStmt nodes */
2834 static bool
2836 {
2837  if (list_length(pstmts) == 1)
2838  {
2839  PlannedStmt *pstmt = linitial_node(PlannedStmt, pstmts);
2840 
2841  if (pstmt->commandType == CMD_UTILITY &&
2842  IsA(pstmt->utilityStmt, TransactionStmt))
2843  return true;
2844  }
2845  return false;
2846 }
2847 
2848 /* Release any existing unnamed prepared statement */
2849 static void
2851 {
2852  /* paranoia to avoid a dangling pointer in case of error */
2853  if (unnamed_stmt_psrc)
2854  {
2856 
2857  unnamed_stmt_psrc = NULL;
2858  DropCachedPlan(psrc);
2859  }
2860 }
2861 
2862 
2863 /* --------------------------------
2864  * signal handler routines used in PostgresMain()
2865  * --------------------------------
2866  */
2867 
2868 /*
2869  * quickdie() occurs when signaled SIGQUIT by the postmaster.
2870  *
2871  * Either some backend has bought the farm, or we've been told to shut down
2872  * "immediately"; so we need to stop what we're doing and exit.
2873  */
2874 void
2876 {
2877  sigaddset(&BlockSig, SIGQUIT); /* prevent nested calls */
2878  sigprocmask(SIG_SETMASK, &BlockSig, NULL);
2879 
2880  /*
2881  * Prevent interrupts while exiting; though we just blocked signals that
2882  * would queue new interrupts, one may have been pending. We don't want a
2883  * quickdie() downgraded to a mere query cancel.
2884  */
2885  HOLD_INTERRUPTS();
2886 
2887  /*
2888  * If we're aborting out of client auth, don't risk trying to send
2889  * anything to the client; we will likely violate the protocol, not to
2890  * mention that we may have interrupted the guts of OpenSSL or some
2891  * authentication library.
2892  */
2895 
2896  /*
2897  * Notify the client before exiting, to give a clue on what happened.
2898  *
2899  * It's dubious to call ereport() from a signal handler. It is certainly
2900  * not async-signal safe. But it seems better to try, than to disconnect
2901  * abruptly and leave the client wondering what happened. It's remotely
2902  * possible that we crash or hang while trying to send the message, but
2903  * receiving a SIGQUIT is a sign that something has already gone badly
2904  * wrong, so there's not much to lose. Assuming the postmaster is still
2905  * running, it will SIGKILL us soon if we get stuck for some reason.
2906  *
2907  * One thing we can do to make this a tad safer is to clear the error
2908  * context stack, so that context callbacks are not called. That's a lot
2909  * less code that could be reached here, and the context info is unlikely
2910  * to be very relevant to a SIGQUIT report anyway.
2911  */
2912  error_context_stack = NULL;
2913 
2914  /*
2915  * When responding to a postmaster-issued signal, we send the message only
2916  * to the client; sending to the server log just creates log spam, plus
2917  * it's more code that we need to hope will work in a signal handler.
2918  *
2919  * Ideally these should be ereport(FATAL), but then we'd not get control
2920  * back to force the correct type of process exit.
2921  */
2922  switch (GetQuitSignalReason())
2923  {
2924  case PMQUIT_NOT_SENT:
2925  /* Hmm, SIGQUIT arrived out of the blue */
2926  ereport(WARNING,
2927  (errcode(ERRCODE_ADMIN_SHUTDOWN),
2928  errmsg("terminating connection because of unexpected SIGQUIT signal")));
2929  break;
2930  case PMQUIT_FOR_CRASH:
2931  /* A crash-and-restart cycle is in progress */
2933  (errcode(ERRCODE_CRASH_SHUTDOWN),
2934  errmsg("terminating connection because of crash of another server process"),
2935  errdetail("The postmaster has commanded this server process to roll back"
2936  " the current transaction and exit, because another"
2937  " server process exited abnormally and possibly corrupted"
2938  " shared memory."),
2939  errhint("In a moment you should be able to reconnect to the"
2940  " database and repeat your command.")));
2941  break;
2942  case PMQUIT_FOR_STOP:
2943  /* Immediate-mode stop */
2945  (errcode(ERRCODE_ADMIN_SHUTDOWN),
2946  errmsg("terminating connection due to immediate shutdown command")));
2947  break;
2948  }
2949 
2950  /*
2951  * We DO NOT want to run proc_exit() or atexit() callbacks -- we're here
2952  * because shared memory may be corrupted, so we don't want to try to
2953  * clean up our transaction. Just nail the windows shut and get out of
2954  * town. The callbacks wouldn't be safe to run from a signal handler,
2955  * anyway.
2956  *
2957  * Note we do _exit(2) not _exit(0). This is to force the postmaster into
2958  * a system reset cycle if someone sends a manual SIGQUIT to a random
2959  * backend. This is necessary precisely because we don't clean up our
2960  * shared memory state. (The "dead man switch" mechanism in pmsignal.c
2961  * should ensure the postmaster sees this as a crash, too, but no harm in
2962  * being doubly sure.)
2963  */
2964  _exit(2);
2965 }
2966 
2967 /*
2968  * Shutdown signal from postmaster: abort transaction and exit
2969  * at soonest convenient time
2970  */
2971 void
2973 {
2974  /* Don't joggle the elbow of proc_exit */
2975  if (!proc_exit_inprogress)
2976  {
2977  InterruptPending = true;
2978  ProcDiePending = true;
2979  }
2980 
2981  /* for the cumulative stats system */
2983 
2984  /* If we're still here, waken anything waiting on the process latch */
2985  SetLatch(MyLatch);
2986 
2987  /*
2988  * If we're in single user mode, we want to quit immediately - we can't
2989  * rely on latches as they wouldn't work when stdin/stdout is a file.
2990  * Rather ugly, but it's unlikely to be worthwhile to invest much more
2991  * effort just for the benefit of single user mode.
2992  */
2995 }
2996 
2997 /*
2998  * Query-cancel signal from postmaster: abort current transaction
2999  * at soonest convenient time
3000  */
3001 void
3003 {
3004  /*
3005  * Don't joggle the elbow of proc_exit
3006  */
3007  if (!proc_exit_inprogress)
3008  {
3009  InterruptPending = true;
3010  QueryCancelPending = true;
3011  }
3012 
3013  /* If we're still here, waken anything waiting on the process latch */
3014  SetLatch(MyLatch);
3015 }
3016 
3017 /* signal handler for floating point exception */
3018 void
3020 {
3021  /* We're not returning, so no need to save errno */
3022  ereport(ERROR,
3023  (errcode(ERRCODE_FLOATING_POINT_EXCEPTION),
3024  errmsg("floating-point exception"),
3025  errdetail("An invalid floating-point operation was signaled. "
3026  "This probably means an out-of-range result or an "
3027  "invalid operation, such as division by zero.")));
3028 }
3029 
3030 /*
3031  * Tell the next CHECK_FOR_INTERRUPTS() to check for a particular type of
3032  * recovery conflict. Runs in a SIGUSR1 handler.
3033  */
3034 void
3036 {
3037  RecoveryConflictPendingReasons[reason] = true;
3038  RecoveryConflictPending = true;
3039  InterruptPending = true;
3040  /* latch will be set by procsignal_sigusr1_handler */
3041 }
3042 
3043 /*
3044  * Check one individual conflict reason.
3045  */
3046 static void
3048 {
3049  switch (reason)
3050  {
3052 
3053  /*
3054  * If we aren't waiting for a lock we can never deadlock.
3055  */
3056  if (!IsWaitingForLock())
3057  return;
3058 
3059  /* Intentional fall through to check wait for pin */
3060  /* FALLTHROUGH */
3061 
3063 
3064  /*
3065  * If PROCSIG_RECOVERY_CONFLICT_BUFFERPIN is requested but we
3066  * aren't blocking the Startup process there is nothing more to
3067  * do.
3068  *
3069  * When PROCSIG_RECOVERY_CONFLICT_STARTUP_DEADLOCK is requested,
3070  * if we're waiting for locks and the startup process is not
3071  * waiting for buffer pin (i.e., also waiting for locks), we set
3072  * the flag so that ProcSleep() will check for deadlocks.
3073  */
3075  {
3079  return;
3080  }
3081 
3083 
3084  /* Intentional fall through to error handling */
3085  /* FALLTHROUGH */
3086 
3090 
3091  /*
3092  * If we aren't in a transaction any longer then ignore.
3093  */
3095  return;
3096 
3097  /* FALLTHROUGH */
3098 
3100 
3101  /*
3102  * If we're not in a subtransaction then we are OK to throw an
3103  * ERROR to resolve the conflict. Otherwise drop through to the
3104  * FATAL case.
3105  *
3106  * PROCSIG_RECOVERY_CONFLICT_LOGICALSLOT is a special case that
3107  * always throws an ERROR (ie never promotes to FATAL), though it
3108  * still has to respect QueryCancelHoldoffCount, so it shares this
3109  * code path. Logical decoding slots are only acquired while
3110  * performing logical decoding. During logical decoding no user
3111  * controlled code is run. During [sub]transaction abort, the
3112  * slot is released. Therefore user controlled code cannot
3113  * intercept an error before the replication slot is released.
3114  *
3115  * XXX other times that we can throw just an ERROR *may* be
3116  * PROCSIG_RECOVERY_CONFLICT_LOCK if no locks are held in parent
3117  * transactions
3118  *
3119  * PROCSIG_RECOVERY_CONFLICT_SNAPSHOT if no snapshots are held by
3120  * parent transactions and the transaction is not
3121  * transaction-snapshot mode
3122  *
3123  * PROCSIG_RECOVERY_CONFLICT_TABLESPACE if no temp files or
3124  * cursors open in parent transactions
3125  */
3126  if (reason == PROCSIG_RECOVERY_CONFLICT_LOGICALSLOT ||
3127  !IsSubTransaction())
3128  {
3129  /*
3130  * If we already aborted then we no longer need to cancel. We
3131  * do this here since we do not wish to ignore aborted
3132  * subtransactions, which must cause FATAL, currently.
3133  */
3135  return;
3136 
3137  /*
3138  * If a recovery conflict happens while we are waiting for
3139  * input from the client, the client is presumably just
3140  * sitting idle in a transaction, preventing recovery from
3141  * making progress. We'll drop through to the FATAL case
3142  * below to dislodge it, in that case.
3143  */
3144  if (!DoingCommandRead)
3145  {
3146  /* Avoid losing sync in the FE/BE protocol. */
3147  if (QueryCancelHoldoffCount != 0)
3148  {
3149  /*
3150  * Re-arm and defer this interrupt until later. See
3151  * similar code in ProcessInterrupts().
3152  */
3153  RecoveryConflictPendingReasons[reason] = true;
3154  RecoveryConflictPending = true;
3155  InterruptPending = true;
3156  return;
3157  }
3158 
3159  /*
3160  * We are cleared to throw an ERROR. Either it's the
3161  * logical slot case, or we have a top-level transaction
3162  * that we can abort and a conflict that isn't inherently
3163  * non-retryable.
3164  */
3165  LockErrorCleanup();
3167  ereport(ERROR,
3169  errmsg("canceling statement due to conflict with recovery"),
3170  errdetail_recovery_conflict(reason)));
3171  break;
3172  }
3173  }
3174 
3175  /* Intentional fall through to session cancel */
3176  /* FALLTHROUGH */
3177 
3179 
3180  /*
3181  * Retrying is not possible because the database is dropped, or we
3182  * decided above that we couldn't resolve the conflict with an
3183  * ERROR and fell through. Terminate the session.
3184  */
3186  ereport(FATAL,
3188  ERRCODE_DATABASE_DROPPED :
3190  errmsg("terminating connection due to conflict with recovery"),
3192  errhint("In a moment you should be able to reconnect to the"
3193  " database and repeat your command.")));
3194  break;
3195 
3196  default:
3197  elog(FATAL, "unrecognized conflict mode: %d", (int) reason);
3198  }
3199 }
3200 
3201 /*
3202  * Check each possible recovery conflict reason.
3203  */
3204 static void
3206 {
3207  /*
3208  * We don't need to worry about joggling the elbow of proc_exit, because
3209  * proc_exit_prepare() holds interrupts, so ProcessInterrupts() won't call
3210  * us.
3211  */
3215 
3216  RecoveryConflictPending = false;
3217 
3220  reason++)
3221  {
3222  if (RecoveryConflictPendingReasons[reason])
3223  {
3224  RecoveryConflictPendingReasons[reason] = false;
3226  }
3227  }
3228 }
3229 
3230 /*
3231  * ProcessInterrupts: out-of-line portion of CHECK_FOR_INTERRUPTS() macro
3232  *
3233  * If an interrupt condition is pending, and it's safe to service it,
3234  * then clear the flag and accept the interrupt. Called only when
3235  * InterruptPending is true.
3236  *
3237  * Note: if INTERRUPTS_CAN_BE_PROCESSED() is true, then ProcessInterrupts
3238  * is guaranteed to clear the InterruptPending flag before returning.
3239  * (This is not the same as guaranteeing that it's still clear when we
3240  * return; another interrupt could have arrived. But we promise that
3241  * any pre-existing one will have been serviced.)
3242  */
3243 void
3245 {
3246  /* OK to accept any interrupts now? */
3247  if (InterruptHoldoffCount != 0 || CritSectionCount != 0)
3248  return;
3249  InterruptPending = false;
3250 
3251  if (ProcDiePending)
3252  {
3253  ProcDiePending = false;
3254  QueryCancelPending = false; /* ProcDie trumps QueryCancel */
3255  LockErrorCleanup();
3256  /* As in quickdie, don't risk sending to client during auth */
3260  ereport(FATAL,
3261  (errcode(ERRCODE_QUERY_CANCELED),
3262  errmsg("canceling authentication due to timeout")));
3263  else if (AmAutoVacuumWorkerProcess())
3264  ereport(FATAL,
3265  (errcode(ERRCODE_ADMIN_SHUTDOWN),
3266  errmsg("terminating autovacuum process due to administrator command")));
3267  else if (IsLogicalWorker())
3268  ereport(FATAL,
3269  (errcode(ERRCODE_ADMIN_SHUTDOWN),
3270  errmsg("terminating logical replication worker due to administrator command")));
3271  else if (IsLogicalLauncher())
3272  {
3273  ereport(DEBUG1,
3274  (errmsg_internal("logical replication launcher shutting down")));
3275 
3276  /*
3277  * The logical replication launcher can be stopped at any time.
3278  * Use exit status 1 so the background worker is restarted.
3279  */
3280  proc_exit(1);
3281  }
3282  else if (AmBackgroundWorkerProcess())
3283  ereport(FATAL,
3284  (errcode(ERRCODE_ADMIN_SHUTDOWN),
3285  errmsg("terminating background worker \"%s\" due to administrator command",
3287  else
3288  ereport(FATAL,
3289  (errcode(ERRCODE_ADMIN_SHUTDOWN),
3290  errmsg("terminating connection due to administrator command")));
3291  }
3292 
3294  {
3296 
3297  /*
3298  * Check for lost connection and re-arm, if still configured, but not
3299  * if we've arrived back at DoingCommandRead state. We don't want to
3300  * wake up idle sessions, and they already know how to detect lost
3301  * connections.
3302  */
3304  {
3305  if (!pq_check_connection())
3306  ClientConnectionLost = true;
3307  else
3310  }
3311  }
3312 
3314  {
3315  QueryCancelPending = false; /* lost connection trumps QueryCancel */
3316  LockErrorCleanup();
3317  /* don't send to client, we already know the connection to be dead. */
3319  ereport(FATAL,
3320  (errcode(ERRCODE_CONNECTION_FAILURE),
3321  errmsg("connection to client lost")));
3322  }
3323 
3324  /*
3325  * Don't allow query cancel interrupts while reading input from the
3326  * client, because we might lose sync in the FE/BE protocol. (Die
3327  * interrupts are OK, because we won't read any further messages from the
3328  * client in that case.)
3329  *
3330  * See similar logic in ProcessRecoveryConflictInterrupts().
3331  */
3333  {
3334  /*
3335  * Re-arm InterruptPending so that we process the cancel request as
3336  * soon as we're done reading the message. (XXX this is seriously
3337  * ugly: it complicates INTERRUPTS_CAN_BE_PROCESSED(), and it means we
3338  * can't use that macro directly as the initial test in this function,
3339  * meaning that this code also creates opportunities for other bugs to
3340  * appear.)
3341  */
3342  InterruptPending = true;
3343  }
3344  else if (QueryCancelPending)
3345  {
3346  bool lock_timeout_occurred;
3347  bool stmt_timeout_occurred;
3348 
3349  QueryCancelPending = false;
3350 
3351  /*
3352  * If LOCK_TIMEOUT and STATEMENT_TIMEOUT indicators are both set, we
3353  * need to clear both, so always fetch both.
3354  */
3355  lock_timeout_occurred = get_timeout_indicator(LOCK_TIMEOUT, true);
3356  stmt_timeout_occurred = get_timeout_indicator(STATEMENT_TIMEOUT, true);
3357 
3358  /*
3359  * If both were set, we want to report whichever timeout completed
3360  * earlier; this ensures consistent behavior if the machine is slow
3361  * enough that the second timeout triggers before we get here. A tie
3362  * is arbitrarily broken in favor of reporting a lock timeout.
3363  */
3364  if (lock_timeout_occurred && stmt_timeout_occurred &&
3366  lock_timeout_occurred = false; /* report stmt timeout */
3367 
3368  if (lock_timeout_occurred)
3369  {
3370  LockErrorCleanup();
3371  ereport(ERROR,
3372  (errcode(ERRCODE_LOCK_NOT_AVAILABLE),
3373  errmsg("canceling statement due to lock timeout")));
3374  }
3375  if (stmt_timeout_occurred)
3376  {
3377  LockErrorCleanup();
3378  ereport(ERROR,
3379  (errcode(ERRCODE_QUERY_CANCELED),
3380  errmsg("canceling statement due to statement timeout")));
3381  }
3383  {
3384  LockErrorCleanup();
3385  ereport(ERROR,
3386  (errcode(ERRCODE_QUERY_CANCELED),
3387  errmsg("canceling autovacuum task")));
3388  }
3389 
3390  /*
3391  * If we are reading a command from the client, just ignore the cancel
3392  * request --- sending an extra error message won't accomplish
3393  * anything. Otherwise, go ahead and throw the error.
3394  */
3395  if (!DoingCommandRead)
3396  {
3397  LockErrorCleanup();
3398  ereport(ERROR,
3399  (errcode(ERRCODE_QUERY_CANCELED),
3400  errmsg("canceling statement due to user request")));
3401  }
3402  }
3403 
3406 
3408  {
3409  /*
3410  * If the GUC has been reset to zero, ignore the signal. This is
3411  * important because the GUC update itself won't disable any pending
3412  * interrupt. We need to unset the flag before the injection point,
3413  * otherwise we could loop in interrupts checking.
3414  */
3417  {
3418  INJECTION_POINT("idle-in-transaction-session-timeout");
3419  ereport(FATAL,
3420  (errcode(ERRCODE_IDLE_IN_TRANSACTION_SESSION_TIMEOUT),
3421  errmsg("terminating connection due to idle-in-transaction timeout")));
3422  }
3423  }
3424 
3426  {
3427  /* As above, ignore the signal if the GUC has been reset to zero. */
3428  TransactionTimeoutPending = false;
3429  if (TransactionTimeout > 0)
3430  {
3431  INJECTION_POINT("transaction-timeout");
3432  ereport(FATAL,
3433  (errcode(ERRCODE_TRANSACTION_TIMEOUT),
3434  errmsg("terminating connection due to transaction timeout")));
3435  }
3436  }
3437 
3439  {
3440  /* As above, ignore the signal if the GUC has been reset to zero. */
3441  IdleSessionTimeoutPending = false;
3442  if (IdleSessionTimeout > 0)
3443  {
3444  INJECTION_POINT("idle-session-timeout");
3445  ereport(FATAL,
3446  (errcode(ERRCODE_IDLE_SESSION_TIMEOUT),
3447  errmsg("terminating connection due to idle-session timeout")));
3448  }
3449  }
3450 
3451  /*
3452  * If there are pending stats updates and we currently are truly idle
3453  * (matching the conditions in PostgresMain(), report stats now.
3454  */
3457  {
3459  pgstat_report_stat(true);
3460  }
3461 
3464 
3467 
3470 
3473 }
3474 
3475 /*
3476  * set_stack_base: set up reference point for stack depth checking
3477  *
3478  * Returns the old reference point, if any.
3479  */
3482 {
3483 #ifndef HAVE__BUILTIN_FRAME_ADDRESS
3484  char stack_base;
3485 #endif
3486  pg_stack_base_t old;
3487 
3488  old = stack_base_ptr;
3489 
3490  /*
3491  * Set up reference point for stack depth checking. On recent gcc we use
3492  * __builtin_frame_address() to avoid a warning about storing a local
3493  * variable's address in a long-lived variable.
3494  */
3495 #ifdef HAVE__BUILTIN_FRAME_ADDRESS
3496  stack_base_ptr = __builtin_frame_address(0);
3497 #else
3498  stack_base_ptr = &stack_base;
3499 #endif
3500 
3501  return old;
3502 }
3503 
3504 /*
3505  * restore_stack_base: restore reference point for stack depth checking
3506  *
3507  * This can be used after set_stack_base() to restore the old value. This
3508  * is currently only used in PL/Java. When PL/Java calls a backend function
3509  * from different thread, the thread's stack is at a different location than
3510  * the main thread's stack, so it sets the base pointer before the call, and
3511  * restores it afterwards.
3512  */
3513 void
3515 {
3516  stack_base_ptr = base;
3517 }
3518 
3519 /*
3520  * check_stack_depth/stack_is_too_deep: check for excessively deep recursion
3521  *
3522  * This should be called someplace in any recursive routine that might possibly
3523  * recurse deep enough to overflow the stack. Most Unixen treat stack
3524  * overflow as an unrecoverable SIGSEGV, so we want to error out ourselves
3525  * before hitting the hardware limit.
3526  *
3527  * check_stack_depth() just throws an error summarily. stack_is_too_deep()
3528  * can be used by code that wants to handle the error condition itself.
3529  */
3530 void
3532 {
3533  if (stack_is_too_deep())
3534  {
3535  ereport(ERROR,
3536  (errcode(ERRCODE_STATEMENT_TOO_COMPLEX),
3537  errmsg("stack depth limit exceeded"),
3538  errhint("Increase the configuration parameter max_stack_depth (currently %dkB), "
3539  "after ensuring the platform's stack depth limit is adequate.",
3540  max_stack_depth)));
3541  }
3542 }
3543 
3544 bool
3546 {
3547  char stack_top_loc;
3548  long stack_depth;
3549 
3550  /*
3551  * Compute distance from reference point to my local variables
3552  */
3553  stack_depth = (long) (stack_base_ptr - &stack_top_loc);
3554 
3555  /*
3556  * Take abs value, since stacks grow up on some machines, down on others
3557  */
3558  if (stack_depth < 0)
3559  stack_depth = -stack_depth;
3560 
3561  /*
3562  * Trouble?
3563  *
3564  * The test on stack_base_ptr prevents us from erroring out if called
3565  * during process setup or in a non-backend process. Logically it should
3566  * be done first, but putting it here avoids wasting cycles during normal
3567  * cases.
3568  */
3569  if (stack_depth > max_stack_depth_bytes &&
3570  stack_base_ptr != NULL)
3571  return true;
3572 
3573  return false;
3574 }
3575 
3576 /* GUC check hook for max_stack_depth */
3577 bool
3579 {
3580  long newval_bytes = *newval * 1024L;
3581  long stack_rlimit = get_stack_depth_rlimit();
3582 
3583  if (stack_rlimit > 0 && newval_bytes > stack_rlimit - STACK_DEPTH_SLOP)
3584  {
3585  GUC_check_errdetail("max_stack_depth must not exceed %ldkB.",
3586  (stack_rlimit - STACK_DEPTH_SLOP) / 1024L);
3587  GUC_check_errhint("Increase the platform's stack depth limit via \"ulimit -s\" or local equivalent.");
3588  return false;
3589  }
3590  return true;
3591 }
3592 
3593 /* GUC assign hook for max_stack_depth */
3594 void
3596 {
3597  long newval_bytes = newval * 1024L;
3598 
3599  max_stack_depth_bytes = newval_bytes;
3600 }
3601 
3602 /*
3603  * GUC check_hook for client_connection_check_interval
3604  */
3605 bool
3607 {
3608  if (!WaitEventSetCanReportClosed() && *newval != 0)
3609  {
3610  GUC_check_errdetail("client_connection_check_interval must be set to 0 on this platform.");
3611  return false;
3612  }
3613  return true;
3614 }
3615 
3616 /*
3617  * GUC check_hook for log_parser_stats, log_planner_stats, log_executor_stats
3618  *
3619  * This function and check_log_stats interact to prevent their variables from
3620  * being set in a disallowed combination. This is a hack that doesn't really
3621  * work right; for example it might fail while applying pg_db_role_setting
3622  * values even though the final state would have been acceptable. However,
3623  * since these variables are legacy settings with little production usage,
3624  * we tolerate that.
3625  */
3626 bool
3628 {
3629  if (*newval && log_statement_stats)
3630  {
3631  GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
3632  return false;
3633  }
3634  return true;
3635 }
3636 
3637 /*
3638  * GUC check_hook for log_statement_stats
3639  */
3640 bool
3642 {
3643  if (*newval &&
3645  {
3646  GUC_check_errdetail("Cannot enable log_statement_stats when "
3647  "log_parser_stats, log_planner_stats, "
3648  "or log_executor_stats is true.");
3649  return false;
3650  }
3651  return true;
3652 }
3653 
3654 /* GUC assign hook for transaction_timeout */
3655 void
3657 {
3658  if (IsTransactionState())
3659  {
3660  /*
3661  * If transaction_timeout GUC has changed within the transaction block
3662  * enable or disable the timer correspondingly.
3663  */
3666  else if (newval <= 0 && get_timeout_active(TRANSACTION_TIMEOUT))
3668  }
3669 }
3670 
3671 
3672 /*
3673  * set_debug_options --- apply "-d N" command line option
3674  *
3675  * -d is not quite the same as setting log_min_messages because it enables
3676  * other output options.
3677  */
3678 void
3680 {
3681  if (debug_flag > 0)
3682  {
3683  char debugstr[64];
3684 
3685  sprintf(debugstr, "debug%d", debug_flag);
3686  SetConfigOption("log_min_messages", debugstr, context, source);
3687  }
3688  else
3689  SetConfigOption("log_min_messages", "notice", context, source);
3690 
3691  if (debug_flag >= 1 && context == PGC_POSTMASTER)
3692  {
3693  SetConfigOption("log_connections", "true", context, source);
3694  SetConfigOption("log_disconnections", "true", context, source);
3695  }
3696  if (debug_flag >= 2)
3697  SetConfigOption("log_statement", "all", context, source);
3698  if (debug_flag >= 3)
3699  SetConfigOption("debug_print_parse", "true", context, source);
3700  if (debug_flag >= 4)
3701  SetConfigOption("debug_print_plan", "true", context, source);
3702  if (debug_flag >= 5)
3703  SetConfigOption("debug_print_rewritten", "true", context, source);
3704 }
3705 
3706 
3707 bool
3709 {
3710  const char *tmp = NULL;
3711 
3712  switch (arg[0])
3713  {
3714  case 's': /* seqscan */
3715  tmp = "enable_seqscan";
3716  break;
3717  case 'i': /* indexscan */
3718  tmp = "enable_indexscan";
3719  break;
3720  case 'o': /* indexonlyscan */
3721  tmp = "enable_indexonlyscan";
3722  break;
3723  case 'b': /* bitmapscan */
3724  tmp = "enable_bitmapscan";
3725  break;
3726  case 't': /* tidscan */
3727  tmp = "enable_tidscan";
3728  break;
3729  case 'n': /* nestloop */
3730  tmp = "enable_nestloop";
3731  break;
3732  case 'm': /* mergejoin */
3733  tmp = "enable_mergejoin";
3734  break;
3735  case 'h': /* hashjoin */
3736  tmp = "enable_hashjoin";
3737  break;
3738  }
3739  if (tmp)
3740  {
3741  SetConfigOption(tmp, "false", context, source);
3742  return true;
3743  }
3744  else
3745  return false;
3746 }
3747 
3748 
3749 const char *
3751 {
3752  switch (arg[0])
3753  {
3754  case 'p':
3755  if (optarg[1] == 'a') /* "parser" */
3756  return "log_parser_stats";
3757  else if (optarg[1] == 'l') /* "planner" */
3758  return "log_planner_stats";
3759  break;
3760 
3761  case 'e': /* "executor" */
3762  return "log_executor_stats";
3763  break;
3764  }
3765 
3766  return NULL;
3767 }
3768 
3769 
3770 /* ----------------------------------------------------------------
3771  * process_postgres_switches
3772  * Parse command line arguments for backends
3773  *
3774  * This is called twice, once for the "secure" options coming from the
3775  * postmaster or command line, and once for the "insecure" options coming
3776  * from the client's startup packet. The latter have the same syntax but
3777  * may be restricted in what they can do.
3778  *
3779  * argv[0] is ignored in either case (it's assumed to be the program name).
3780  *
3781  * ctx is PGC_POSTMASTER for secure options, PGC_BACKEND for insecure options
3782  * coming from the client, or PGC_SU_BACKEND for insecure options coming from
3783  * a superuser client.
3784  *
3785  * If a database name is present in the command line arguments, it's
3786  * returned into *dbname (this is allowed only if *dbname is initially NULL).
3787  * ----------------------------------------------------------------
3788  */
3789 void
3790 process_postgres_switches(int argc, char *argv[], GucContext ctx,
3791  const char **dbname)
3792 {
3793  bool secure = (ctx == PGC_POSTMASTER);
3794  int errs = 0;
3795  GucSource gucsource;
3796  int flag;
3797 
3798  if (secure)
3799  {
3800  gucsource = PGC_S_ARGV; /* switches came from command line */
3801 
3802  /* Ignore the initial --single argument, if present */
3803  if (argc > 1 && strcmp(argv[1], "--single") == 0)
3804  {
3805  argv++;
3806  argc--;
3807  }
3808  }
3809  else
3810  {
3811  gucsource = PGC_S_CLIENT; /* switches came from client */
3812  }
3813 
3814 #ifdef HAVE_INT_OPTERR
3815 
3816  /*
3817  * Turn this off because it's either printed to stderr and not the log
3818  * where we'd want it, or argv[0] is now "--single", which would make for
3819  * a weird error message. We print our own error message below.
3820  */
3821  opterr = 0;
3822 #endif
3823 
3824  /*
3825  * Parse command-line options. CAUTION: keep this in sync with
3826  * postmaster/postmaster.c (the option sets should not conflict) and with
3827  * the common help() function in main/main.c.
3828  */
3829  while ((flag = getopt(argc, argv, "B:bC:c:D:d:EeFf:h:ijk:lN:nOPp:r:S:sTt:v:W:-:")) != -1)
3830  {
3831  switch (flag)
3832  {
3833  case 'B':
3834  SetConfigOption("shared_buffers", optarg, ctx, gucsource);
3835  break;
3836 
3837  case 'b':
3838  /* Undocumented flag used for binary upgrades */
3839  if (secure)
3840  IsBinaryUpgrade = true;
3841  break;
3842 
3843  case 'C':
3844  /* ignored for consistency with the postmaster */
3845  break;
3846 
3847  case 'c':
3848  case '-':
3849  {
3850  char *name,
3851  *value;
3852 
3854  if (!value)
3855  {
3856  if (flag == '-')
3857  ereport(ERROR,
3858  (errcode(ERRCODE_SYNTAX_ERROR),
3859  errmsg("--%s requires a value",
3860  optarg)));
3861  else
3862  ereport(ERROR,
3863  (errcode(ERRCODE_SYNTAX_ERROR),
3864  errmsg("-c %s requires a value",
3865  optarg)));
3866  }
3867  SetConfigOption(name, value, ctx, gucsource);
3868  pfree(name);
3869  pfree(value);
3870  break;
3871  }
3872 
3873  case 'D':
3874  if (secure)
3875  userDoption = strdup(optarg);
3876  break;
3877 
3878  case 'd':
3879  set_debug_options(atoi(optarg), ctx, gucsource);
3880  break;
3881 
3882  case 'E':
3883  if (secure)
3884  EchoQuery = true;
3885  break;
3886 
3887  case 'e':
3888  SetConfigOption("datestyle", "euro", ctx, gucsource);
3889  break;
3890 
3891  case 'F':
3892  SetConfigOption("fsync", "false", ctx, gucsource);
3893  break;
3894 
3895  case 'f':
3896  if (!set_plan_disabling_options(optarg, ctx, gucsource))
3897  errs++;
3898  break;
3899 
3900  case 'h':
3901  SetConfigOption("listen_addresses", optarg, ctx, gucsource);
3902  break;
3903 
3904  case 'i':
3905  SetConfigOption("listen_addresses", "*", ctx, gucsource);
3906  break;
3907 
3908  case 'j':
3909  if (secure)
3910  UseSemiNewlineNewline = true;
3911  break;
3912 
3913  case 'k':
3914  SetConfigOption("unix_socket_directories", optarg, ctx, gucsource);
3915  break;
3916 
3917  case 'l':
3918  SetConfigOption("ssl", "true", ctx, gucsource);
3919  break;
3920 
3921  case 'N':
3922  SetConfigOption("max_connections", optarg, ctx, gucsource);
3923  break;
3924 
3925  case 'n':
3926  /* ignored for consistency with postmaster */
3927  break;
3928 
3929  case 'O':
3930  SetConfigOption("allow_system_table_mods", "true", ctx, gucsource);
3931  break;
3932 
3933  case 'P':
3934  SetConfigOption("ignore_system_indexes", "true", ctx, gucsource);
3935  break;
3936 
3937  case 'p':
3938  SetConfigOption("port", optarg, ctx, gucsource);
3939  break;
3940 
3941  case 'r':
3942  /* send output (stdout and stderr) to the given file */
3943  if (secure)
3945  break;
3946 
3947  case 'S':
3948  SetConfigOption("work_mem", optarg, ctx, gucsource);
3949  break;
3950 
3951  case 's':
3952  SetConfigOption("log_statement_stats", "true", ctx, gucsource);
3953  break;
3954 
3955  case 'T':
3956  /* ignored for consistency with the postmaster */
3957  break;
3958 
3959  case 't':
3960  {
3961  const char *tmp = get_stats_option_name(optarg);
3962 
3963  if (tmp)
3964  SetConfigOption(tmp, "true", ctx, gucsource);
3965  else
3966  errs++;
3967  break;
3968  }
3969 
3970  case 'v':
3971 
3972  /*
3973  * -v is no longer used in normal operation, since
3974  * FrontendProtocol is already set before we get here. We keep
3975  * the switch only for possible use in standalone operation,
3976  * in case we ever support using normal FE/BE protocol with a
3977  * standalone backend.
3978  */
3979  if (secure)
3981  break;
3982 
3983  case 'W':
3984  SetConfigOption("post_auth_delay", optarg, ctx, gucsource);
3985  break;
3986 
3987  default:
3988  errs++;
3989  break;
3990  }
3991 
3992  if (errs)
3993  break;
3994  }
3995 
3996  /*
3997  * Optional database name should be there only if *dbname is NULL.
3998  */
3999  if (!errs && dbname && *dbname == NULL && argc - optind >= 1)
4000  *dbname = strdup(argv[optind++]);
4001 
4002  if (errs || argc != optind)
4003  {
4004  if (errs)
4005  optind--; /* complain about the previous argument */
4006 
4007  /* spell the error message a bit differently depending on context */
4008  if (IsUnderPostmaster)
4009  ereport(FATAL,
4010  errcode(ERRCODE_SYNTAX_ERROR),
4011  errmsg("invalid command-line argument for server process: %s", argv[optind]),
4012  errhint("Try \"%s --help\" for more information.", progname));
4013  else
4014  ereport(FATAL,
4015  errcode(ERRCODE_SYNTAX_ERROR),
4016  errmsg("%s: invalid command-line argument: %s",
4017  progname, argv[optind]),
4018  errhint("Try \"%s --help\" for more information.", progname));
4019  }
4020 
4021  /*
4022  * Reset getopt(3) library so that it will work correctly in subprocesses
4023  * or when this function is called a second time with another array.
4024  */
4025  optind = 1;
4026 #ifdef HAVE_INT_OPTRESET
4027  optreset = 1; /* some systems need this too */
4028 #endif
4029 }
4030 
4031 
4032 /*
4033  * PostgresSingleUserMain
4034  * Entry point for single user mode. argc/argv are the command line
4035  * arguments to be used.
4036  *
4037  * Performs single user specific setup then calls PostgresMain() to actually
4038  * process queries. Single user mode specific setup should go here, rather
4039  * than PostgresMain() or InitPostgres() when reasonably possible.
4040  */
4041 void
4042 PostgresSingleUserMain(int argc, char *argv[],
4043  const char *username)
4044 {
4045  const char *dbname = NULL;
4046 
4048 
4049  /* Initialize startup process environment. */
4050  InitStandaloneProcess(argv[0]);
4051 
4052  /*
4053  * Set default values for command-line options.
4054  */
4056 
4057  /*
4058  * Parse command-line options.
4059  */
4061 
4062  /* Must have gotten a database name, or have a default (the username) */
4063  if (dbname == NULL)
4064  {
4065  dbname = username;
4066  if (dbname == NULL)
4067  ereport(FATAL,
4068  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4069  errmsg("%s: no database nor user name specified",
4070  progname)));
4071  }
4072 
4073  /* Acquire configuration parameters */
4075  proc_exit(1);
4076 
4077  /*
4078  * Validate we have been given a reasonable-looking DataDir and change
4079  * into it.
4080  */
4081  checkDataDir();
4082  ChangeToDataDir();
4083 
4084  /*
4085  * Create lockfile for data directory.
4086  */
4087  CreateDataDirLockFile(false);
4088 
4089  /* read control file (error checking and contains config ) */
4090  LocalProcessControlFile(false);
4091 
4092  /*
4093  * process any libraries that should be preloaded at postmaster start
4094  */
4096 
4097  /* Initialize MaxBackends */
4099 
4100  /*
4101  * Give preloaded libraries a chance to request additional shared memory.
4102  */
4104 
4105  /*
4106  * Now that loadable modules have had their chance to request additional
4107  * shared memory, determine the value of any runtime-computed GUCs that
4108  * depend on the amount of shared memory required.
4109  */
4111 
4112  /*
4113  * Now that modules have been loaded, we can process any custom resource
4114  * managers specified in the wal_consistency_checking GUC.
4115  */
4117 
4119 
4120  /*
4121  * Remember stand-alone backend startup time,roughly at the same point
4122  * during startup that postmaster does so.
4123  */
4125 
4126  /*
4127  * Create a per-backend PGPROC struct in shared memory. We must do this
4128  * before we can use LWLocks.
4129  */
4130  InitProcess();
4131 
4132  /*
4133  * Now that sufficient infrastructure has been initialized, PostgresMain()
4134  * can do the rest.
4135  */
4137 }
4138 
4139 
4140 /* ----------------------------------------------------------------
4141  * PostgresMain
4142  * postgres main loop -- all backends, interactive or otherwise loop here
4143  *
4144  * dbname is the name of the database to connect to, username is the
4145  * PostgreSQL user name to be used for the session.
4146  *
4147  * NB: Single user mode specific setup should go to PostgresSingleUserMain()
4148  * if reasonably possible.
4149  * ----------------------------------------------------------------
4150  */
4151 void
4152 PostgresMain(const char *dbname, const char *username)
4153 {
4154  sigjmp_buf local_sigjmp_buf;
4155 
4156  /* these must be volatile to ensure state is preserved across longjmp: */
4157  volatile bool send_ready_for_query = true;
4158  volatile bool idle_in_transaction_timeout_enabled = false;
4159  volatile bool idle_session_timeout_enabled = false;
4160 
4161  Assert(dbname != NULL);
4162  Assert(username != NULL);
4163 
4165 
4166  /*
4167  * Set up signal handlers. (InitPostmasterChild or InitStandaloneProcess
4168  * has already set up BlockSig and made that the active signal mask.)
4169  *
4170  * Note that postmaster blocked all signals before forking child process,
4171  * so there is no race condition whereby we might receive a signal before
4172  * we have set up the handler.
4173  *
4174  * Also note: it's best not to use any signals that are SIG_IGNored in the
4175  * postmaster. If such a signal arrives before we are able to change the
4176  * handler to non-SIG_IGN, it'll get dropped. Instead, make a dummy
4177  * handler in the postmaster to reserve the signal. (Of course, this isn't
4178  * an issue for signals that are locally generated, such as SIGALRM and
4179  * SIGPIPE.)
4180  */
4181  if (am_walsender)
4182  WalSndSignals();
4183  else
4184  {
4186  pqsignal(SIGINT, StatementCancelHandler); /* cancel current query */
4187  pqsignal(SIGTERM, die); /* cancel current query and exit */
4188 
4189  /*
4190  * In a postmaster child backend, replace SignalHandlerForCrashExit
4191  * with quickdie, so we can tell the client we're dying.
4192  *
4193  * In a standalone backend, SIGQUIT can be generated from the keyboard
4194  * easily, while SIGTERM cannot, so we make both signals do die()
4195  * rather than quickdie().
4196  */
4197  if (IsUnderPostmaster)
4198  pqsignal(SIGQUIT, quickdie); /* hard crash time */
4199  else
4200  pqsignal(SIGQUIT, die); /* cancel current query and exit */
4201  InitializeTimeouts(); /* establishes SIGALRM handler */
4202 
4203  /*
4204  * Ignore failure to write to frontend. Note: if frontend closes
4205  * connection, we will notice it and exit cleanly when control next
4206  * returns to outer loop. This seems safer than forcing exit in the
4207  * midst of output during who-knows-what operation...
4208  */
4213 
4214  /*
4215  * Reset some signals that are accepted by postmaster but not by
4216  * backend
4217  */
4218  pqsignal(SIGCHLD, SIG_DFL); /* system() requires this on some
4219  * platforms */
4220  }
4221 
4222  /* Early initialization */
4223  BaseInit();
4224 
4225  /* We need to allow SIGINT, etc during the initial transaction */
4226  sigprocmask(SIG_SETMASK, &UnBlockSig, NULL);
4227 
4228  /*
4229  * General initialization.
4230  *
4231  * NOTE: if you are tempted to add code in this vicinity, consider putting
4232  * it inside InitPostgres() instead. In particular, anything that
4233  * involves database access should be there, not here.
4234  *
4235  * Honor session_preload_libraries if not dealing with a WAL sender.
4236  */
4237  InitPostgres(dbname, InvalidOid, /* database to connect to */
4238  username, InvalidOid, /* role to connect as */
4240  NULL); /* no out_dbname */
4241 
4242  /*
4243  * If the PostmasterContext is still around, recycle the space; we don't
4244  * need it anymore after InitPostgres completes.
4245  */
4246  if (PostmasterContext)
4247  {
4249  PostmasterContext = NULL;
4250  }
4251 
4253 
4254  /*
4255  * Now all GUC states are fully set up. Report them to client if
4256  * appropriate.
4257  */
4259 
4260  /*
4261  * Also set up handler to log session end; we have to wait till now to be
4262  * sure Log_disconnections has its final value.
4263  */
4266 
4268 
4269  /* Perform initialization specific to a WAL sender process. */
4270  if (am_walsender)
4271  InitWalSender();
4272 
4273  /*
4274  * Send this backend's cancellation info to the frontend.
4275  */
4277  {
4279 
4283  pq_endmessage(&buf);
4284  /* Need not flush since ReadyForQuery will do it. */
4285  }
4286 
4287  /* Welcome banner for standalone case */
4289  printf("\nPostgreSQL stand-alone backend %s\n", PG_VERSION);
4290 
4291  /*
4292  * Create the memory context we will use in the main loop.
4293  *
4294  * MessageContext is reset once per iteration of the main loop, ie, upon
4295  * completion of processing of each command message from the client.
4296  */
4298  "MessageContext",
4300 
4301  /*
4302  * Create memory context and buffer used for RowDescription messages. As
4303  * SendRowDescriptionMessage(), via exec_describe_statement_message(), is
4304  * frequently executed for ever single statement, we don't want to
4305  * allocate a separate buffer every time.
4306  */
4308  "RowDescriptionContext",
4313 
4314  /* Fire any defined login event triggers, if appropriate */
4316 
4317  /*
4318  * POSTGRES main processing loop begins here
4319  *
4320  * If an exception is encountered, processing resumes here so we abort the
4321  * current transaction and start a new one.
4322  *
4323  * You might wonder why this isn't coded as an infinite loop around a
4324  * PG_TRY construct. The reason is that this is the bottom of the
4325  * exception stack, and so with PG_TRY there would be no exception handler
4326  * in force at all during the CATCH part. By leaving the outermost setjmp
4327  * always active, we have at least some chance of recovering from an error
4328  * during error recovery. (If we get into an infinite loop thereby, it
4329  * will soon be stopped by overflow of elog.c's internal state stack.)
4330  *
4331  * Note that we use sigsetjmp(..., 1), so that this function's signal mask
4332  * (to wit, UnBlockSig) will be restored when longjmp'ing to here. This
4333  * is essential in case we longjmp'd out of a signal handler on a platform
4334  * where that leaves the signal blocked. It's not redundant with the
4335  * unblock in AbortTransaction() because the latter is only called if we
4336  * were inside a transaction.
4337  */
4338 
4339  if (sigsetjmp(local_sigjmp_buf, 1) != 0)
4340  {
4341  /*
4342  * NOTE: if you are tempted to add more code in this if-block,
4343  * consider the high probability that it should be in
4344  * AbortTransaction() instead. The only stuff done directly here
4345  * should be stuff that is guaranteed to apply *only* for outer-level
4346  * error recovery, such as adjusting the FE/BE protocol status.
4347  */
4348 
4349  /* Since not using PG_TRY, must reset error stack by hand */
4350  error_context_stack = NULL;
4351 
4352  /* Prevent interrupts while cleaning up */
4353  HOLD_INTERRUPTS();
4354 
4355  /*
4356  * Forget any pending QueryCancel request, since we're returning to
4357  * the idle loop anyway, and cancel any active timeout requests. (In
4358  * future we might want to allow some timeout requests to survive, but
4359  * at minimum it'd be necessary to do reschedule_timeouts(), in case
4360  * we got here because of a query cancel interrupting the SIGALRM
4361  * interrupt handler.) Note in particular that we must clear the
4362  * statement and lock timeout indicators, to prevent any future plain
4363  * query cancels from being misreported as timeouts in case we're
4364  * forgetting a timeout cancel.
4365  */
4366  disable_all_timeouts(false); /* do first to avoid race condition */
4367  QueryCancelPending = false;
4368  idle_in_transaction_timeout_enabled = false;
4369  idle_session_timeout_enabled = false;
4370 
4371  /* Not reading from the client anymore. */
4372  DoingCommandRead = false;
4373 
4374  /* Make sure libpq is in a good state */
4375  pq_comm_reset();
4376 
4377  /* Report the error to the client and/or server log */
4378  EmitErrorReport();
4379 
4380  /*
4381  * If Valgrind noticed something during the erroneous query, print the
4382  * query string, assuming we have one.
4383  */
4385 
4386  /*
4387  * Make sure debug_query_string gets reset before we possibly clobber
4388  * the storage it points at.
4389  */
4390  debug_query_string = NULL;
4391 
4392  /*
4393  * Abort the current transaction in order to recover.
4394  */
4396 
4397  if (am_walsender)
4399 
4401 
4402  /*
4403  * We can't release replication slots inside AbortTransaction() as we
4404  * need to be able to start and abort transactions while having a slot
4405  * acquired. But we never need to hold them across top level errors,
4406  * so releasing here is fine. There also is a before_shmem_exit()
4407  * callback ensuring correct cleanup on FATAL errors.
4408  */
4409  if (MyReplicationSlot != NULL)
4411 
4412  /* We also want to cleanup temporary slots on error. */
4414 
4416 
4417  /*
4418  * Now return to normal top-level context and clear ErrorContext for
4419  * next time.
4420  */
4422  FlushErrorState();
4423 
4424  /*
4425  * If we were handling an extended-query-protocol message, initiate
4426  * skip till next Sync. This also causes us not to issue
4427  * ReadyForQuery (until we get Sync).
4428  */
4430  ignore_till_sync = true;
4431 
4432  /* We don't have a transaction command open anymore */
4433  xact_started = false;
4434 
4435  /*
4436  * If an error occurred while we were reading a message from the
4437  * client, we have potentially lost track of where the previous
4438  * message ends and the next one begins. Even though we have
4439  * otherwise recovered from the error, we cannot safely read any more
4440  * messages from the client, so there isn't much we can do with the
4441  * connection anymore.
4442  */
4443  if (pq_is_reading_msg())
4444  ereport(FATAL,
4445  (errcode(ERRCODE_PROTOCOL_VIOLATION),
4446  errmsg("terminating connection because protocol synchronization was lost")));
4447 
4448  /* Now we can allow interrupts again */
4450  }
4451 
4452  /* We can now handle ereport(ERROR) */
4453  PG_exception_stack = &local_sigjmp_buf;
4454 
4455  if (!ignore_till_sync)
4456  send_ready_for_query = true; /* initially, or after error */
4457 
4458  /*
4459  * Non-error queries loop here.
4460  */
4461 
4462  for (;;)
4463  {
4464  int firstchar;
4465  StringInfoData input_message;
4466 
4467  /*
4468  * At top of loop, reset extended-query-message flag, so that any
4469  * errors encountered in "idle" state don't provoke skip.
4470  */
4472 
4473  /*
4474  * For valgrind reporting purposes, the "current query" begins here.
4475  */
4476 #ifdef USE_VALGRIND
4477  old_valgrind_error_count = VALGRIND_COUNT_ERRORS;
4478 #endif
4479 
4480  /*
4481  * Release storage left over from prior query cycle, and create a new
4482  * query input buffer in the cleared MessageContext.
4483  */
4486 
4487  initStringInfo(&input_message);
4488 
4489  /*
4490  * Also consider releasing our catalog snapshot if any, so that it's
4491  * not preventing advance of global xmin while we wait for the client.
4492  */
4494 
4495  /*
4496  * (1) If we've reached idle state, tell the frontend we're ready for
4497  * a new query.
4498  *
4499  * Note: this includes fflush()'ing the last of the prior output.
4500  *
4501  * This is also a good time to flush out collected statistics to the
4502  * cumulative stats system, and to update the PS stats display. We
4503  * avoid doing those every time through the message loop because it'd
4504  * slow down processing of batched messages, and because we don't want
4505  * to report uncommitted updates (that confuses autovacuum). The
4506  * notification processor wants a call too, if we are not in a
4507  * transaction block.
4508  *
4509  * Also, if an idle timeout is enabled, start the timer for that.
4510  */
4511  if (send_ready_for_query)
4512  {
4514  {
4515  set_ps_display("idle in transaction (aborted)");
4517 
4518  /* Start the idle-in-transaction timer */
4521  {
4522  idle_in_transaction_timeout_enabled = true;
4525  }
4526  }
4528  {
4529  set_ps_display("idle in transaction");
4531 
4532  /* Start the idle-in-transaction timer */
4535  {
4536  idle_in_transaction_timeout_enabled = true;
4539  }
4540  }
4541  else
4542  {
4543  long stats_timeout;
4544 
4545  /*
4546  * Process incoming notifies (including self-notifies), if
4547  * any, and send relevant messages to the client. Doing it
4548  * here helps ensure stable behavior in tests: if any notifies
4549  * were received during the just-finished transaction, they'll
4550  * be seen by the client before ReadyForQuery is.
4551  */
4553  ProcessNotifyInterrupt(false);
4554 
4555  /*
4556  * Check if we need to report stats. If pgstat_report_stat()
4557  * decides it's too soon to flush out pending stats / lock
4558  * contention prevented reporting, it'll tell us when we
4559  * should try to report stats again (so that stats updates
4560  * aren't unduly delayed if the connection goes idle for a
4561  * long time). We only enable the timeout if we don't already
4562  * have a timeout in progress, because we don't disable the
4563  * timeout below. enable_timeout_after() needs to determine
4564  * the current timestamp, which can have a negative
4565  * performance impact. That's OK because pgstat_report_stat()
4566  * won't have us wake up sooner than a prior call.
4567  */
4568  stats_timeout = pgstat_report_stat(false);
4569  if (stats_timeout > 0)
4570  {
4573  stats_timeout);
4574  }
4575  else
4576  {
4577  /* all stats flushed, no need for the timeout */
4580  }
4581 
4582  set_ps_display("idle");
4584 
4585  /* Start the idle-session timer */
4586  if (IdleSessionTimeout > 0)
4587  {
4588  idle_session_timeout_enabled = true;
4591  }
4592  }
4593 
4594  /* Report any recently-changed GUC options */
4596 
4598  send_ready_for_query = false;
4599  }
4600 
4601  /*
4602  * (2) Allow asynchronous signals to be executed immediately if they
4603  * come in while we are waiting for client input. (This must be
4604  * conditional since we don't want, say, reads on behalf of COPY FROM
4605  * STDIN doing the same thing.)
4606  */
4607  DoingCommandRead = true;
4608 
4609  /*
4610  * (3) read a command (loop blocks here)
4611  */
4612  firstchar = ReadCommand(&input_message);
4613 
4614  /*
4615  * (4) turn off the idle-in-transaction and idle-session timeouts if
4616  * active. We do this before step (5) so that any last-moment timeout
4617  * is certain to be detected in step (5).
4618  *
4619  * At most one of these timeouts will be active, so there's no need to
4620  * worry about combining the timeout.c calls into one.
4621  */
4622  if (idle_in_transaction_timeout_enabled)
4623  {
4625  idle_in_transaction_timeout_enabled = false;
4626  }
4627  if (idle_session_timeout_enabled)
4628  {
4630  idle_session_timeout_enabled = false;
4631  }
4632 
4633  /*
4634  * (5) disable async signal conditions again.
4635  *
4636  * Query cancel is supposed to be a no-op when there is no query in
4637  * progress, so if a query cancel arrived while we were idle, just
4638  * reset QueryCancelPending. ProcessInterrupts() has that effect when
4639  * it's called when DoingCommandRead is set, so check for interrupts
4640  * before resetting DoingCommandRead.
4641  */
4643  DoingCommandRead = false;
4644 
4645  /*
4646  * (6) check for any other interesting events that happened while we
4647  * slept.
4648  */
4649  if (ConfigReloadPending)
4650  {
4651  ConfigReloadPending = false;
4653  }
4654 
4655  /*
4656  * (7) process the command. But ignore it if we're skipping till
4657  * Sync.
4658  */
4659  if (ignore_till_sync && firstchar != EOF)
4660  continue;
4661 
4662  switch (firstchar)
4663  {
4664  case PqMsg_Query:
4665  {
4666  const char *query_string;
4667 
4668  /* Set statement_timestamp() */
4670 
4671  query_string = pq_getmsgstring(&input_message);
4672  pq_getmsgend(&input_message);
4673 
4674  if (am_walsender)
4675  {
4676  if (!exec_replication_command(query_string))
4677  exec_simple_query(query_string);
4678  }
4679  else
4680  exec_simple_query(query_string);
4681 
4682  valgrind_report_error_query(query_string);
4683 
4684  send_ready_for_query = true;
4685  }
4686  break;
4687 
4688  case PqMsg_Parse:
4689  {
4690  const char *stmt_name;
4691  const char *query_string;
4692  int numParams;
4693  Oid *paramTypes = NULL;
4694 
4695  forbidden_in_wal_sender(firstchar);
4696 
4697  /* Set statement_timestamp() */
4699 
4700  stmt_name = pq_getmsgstring(&input_message);
4701  query_string = pq_getmsgstring(&input_message);
4702  numParams = pq_getmsgint(&input_message, 2);
4703  if (numParams > 0)
4704  {
4705  paramTypes = palloc_array(Oid, numParams);
4706  for (int i = 0; i < numParams; i++)
4707  paramTypes[i] = pq_getmsgint(&input_message, 4);
4708  }
4709  pq_getmsgend(&input_message);
4710 
4711  exec_parse_message(query_string, stmt_name,
4712  paramTypes, numParams);
4713 
4714  valgrind_report_error_query(query_string);
4715  }
4716  break;
4717 
4718  case PqMsg_Bind:
4719  forbidden_in_wal_sender(firstchar);
4720 
4721  /* Set statement_timestamp() */
4723 
4724  /*
4725  * this message is complex enough that it seems best to put
4726  * the field extraction out-of-line
4727  */
4728  exec_bind_message(&input_message);
4729 
4730  /* exec_bind_message does valgrind_report_error_query */
4731  break;
4732 
4733  case PqMsg_Execute:
4734  {
4735  const char *portal_name;
4736  int max_rows;
4737 
4738  forbidden_in_wal_sender(firstchar);
4739 
4740  /* Set statement_timestamp() */
4742 
4743  portal_name = pq_getmsgstring(&input_message);
4744  max_rows = pq_getmsgint(&input_message, 4);
4745  pq_getmsgend(&input_message);
4746 
4747  exec_execute_message(portal_name, max_rows);
4748 
4749  /* exec_execute_message does valgrind_report_error_query */
4750  }
4751  break;
4752 
4753  case PqMsg_FunctionCall:
4754  forbidden_in_wal_sender(firstchar);
4755 
4756  /* Set statement_timestamp() */
4758 
4759  /* Report query to various monitoring facilities. */
4761  set_ps_display("<FASTPATH>");
4762 
4763  /* start an xact for this function invocation */
4765 
4766  /*
4767  * Note: we may at this point be inside an aborted
4768  * transaction. We can't throw error for that until we've
4769  * finished reading the function-call message, so
4770  * HandleFunctionRequest() must check for it after doing so.
4771  * Be careful not to do anything that assumes we're inside a
4772  * valid transaction here.
4773  */
4774 
4775  /* switch back to message context */
4777 
4778  HandleFunctionRequest(&input_message);
4779 
4780  /* commit the function-invocation transaction */
4782 
4783  valgrind_report_error_query("fastpath function call");
4784 
4785  send_ready_for_query = true;
4786  break;
4787 
4788  case PqMsg_Close:
4789  {
4790  int close_type;
4791  const char *close_target;
4792 
4793  forbidden_in_wal_sender(firstchar);
4794 
4795  close_type = pq_getmsgbyte(&input_message);
4796  close_target = pq_getmsgstring(&input_message);
4797  pq_getmsgend(&input_message);
4798 
4799  switch (close_type)
4800  {
4801  case 'S':
4802  if (close_target[0] != '\0')
4803  DropPreparedStatement(close_target, false);
4804  else
4805  {
4806  /* special-case the unnamed statement */
4808  }
4809  break;
4810  case 'P':
4811  {
4812  Portal portal;
4813 
4814  portal = GetPortalByName(close_target);
4815  if (PortalIsValid(portal))
4816  PortalDrop(portal, false);
4817  }
4818  break;
4819  default:
4820  ereport(ERROR,
4821  (errcode(ERRCODE_PROTOCOL_VIOLATION),
4822  errmsg("invalid CLOSE message subtype %d",
4823  close_type)));
4824  break;
4825  }
4826 
4829 
4830  valgrind_report_error_query("CLOSE message");
4831  }
4832  break;
4833 
4834  case PqMsg_Describe:
4835  {
4836  int describe_type;
4837  const char *describe_target;
4838 
4839  forbidden_in_wal_sender(firstchar);
4840 
4841  /* Set statement_timestamp() (needed for xact) */
4843 
4844  describe_type = pq_getmsgbyte(&input_message);
4845  describe_target = pq_getmsgstring(&input_message);
4846  pq_getmsgend(&input_message);
4847 
4848  switch (describe_type)
4849  {
4850  case 'S':
4851  exec_describe_statement_message(describe_target);
4852  break;
4853  case 'P':
4854  exec_describe_portal_message(describe_target);
4855  break;
4856  default:
4857  ereport(ERROR,
4858  (errcode(ERRCODE_PROTOCOL_VIOLATION),
4859  errmsg("invalid DESCRIBE message subtype %d",
4860  describe_type)));
4861  break;
4862  }
4863 
4864  valgrind_report_error_query("DESCRIBE message");
4865  }
4866  break;
4867 
4868  case PqMsg_Flush:
4869  pq_getmsgend(&input_message);
4871  pq_flush();
4872  break;
4873 
4874  case PqMsg_Sync:
4875  pq_getmsgend(&input_message);
4877  valgrind_report_error_query("SYNC message");
4878  send_ready_for_query = true;
4879  break;
4880 
4881  /*
4882  * 'X' means that the frontend is closing down the socket. EOF
4883  * means unexpected loss of frontend connection. Either way,
4884  * perform normal shutdown.
4885  */
4886  case EOF:
4887 
4888  /* for the cumulative statistics system */
4890 
4891  /* FALLTHROUGH */
4892 
4893  case PqMsg_Terminate:
4894 
4895  /*
4896  * Reset whereToSendOutput to prevent ereport from attempting
4897  * to send any more messages to client.
4898  */
4901 
4902  /*
4903  * NOTE: if you are tempted to add more code here, DON'T!
4904  * Whatever you had in mind to do should be set up as an
4905  * on_proc_exit or on_shmem_exit callback, instead. Otherwise
4906  * it will fail to be called during other backend-shutdown
4907  * scenarios.
4908  */
4909  proc_exit(0);
4910 
4911  case PqMsg_CopyData:
4912  case PqMsg_CopyDone:
4913  case PqMsg_CopyFail:
4914 
4915  /*
4916  * Accept but ignore these messages, per protocol spec; we
4917  * probably got here because a COPY failed, and the frontend
4918  * is still sending data.
4919  */
4920  break;
4921 
4922  default:
4923  ereport(FATAL,
4924  (errcode(ERRCODE_PROTOCOL_VIOLATION),
4925  errmsg("invalid frontend message type %d",
4926  firstchar)));
4927  }
4928  } /* end of input-reading loop */
4929 }
4930 
4931 /*
4932  * Throw an error if we're a WAL sender process.
4933  *
4934  * This is used to forbid anything else than simple query protocol messages
4935  * in a WAL sender process. 'firstchar' specifies what kind of a forbidden
4936  * message was received, and is used to construct the error message.
4937  */
4938 static void
4940 {
4941  if (am_walsender)
4942  {
4943  if (firstchar == PqMsg_FunctionCall)
4944  ereport(ERROR,
4945  (errcode(ERRCODE_PROTOCOL_VIOLATION),
4946  errmsg("fastpath function calls not supported in a replication connection")));
4947  else
4948  ereport(ERROR,
4949  (errcode(ERRCODE_PROTOCOL_VIOLATION),
4950  errmsg("extended query protocol not supported in a replication connection")));
4951  }
4952 }
4953 
4954 
4955 /*
4956  * Obtain platform stack depth limit (in bytes)
4957  *
4958  * Return -1 if unknown
4959  */
4960 long
4962 {
4963 #if defined(HAVE_GETRLIMIT)
4964  static long val = 0;
4965 
4966  /* This won't change after process launch, so check just once */
4967  if (val == 0)
4968  {
4969  struct rlimit rlim;
4970 
4971  if (getrlimit(RLIMIT_STACK, &rlim) < 0)
4972  val = -1;
4973  else if (rlim.rlim_cur == RLIM_INFINITY)
4974  val = LONG_MAX;
4975  /* rlim_cur is probably of an unsigned type, so check for overflow */
4976  else if (rlim.rlim_cur >= LONG_MAX)
4977  val = LONG_MAX;
4978  else
4979  val = rlim.rlim_cur;
4980  }
4981  return val;
4982 #else
4983  /* On Windows we set the backend stack size in src/backend/Makefile */
4984  return WIN32_STACK_RLIMIT;
4985 #endif
4986 }
4987 
4988 
4989 static struct rusage Save_r;
4990 static struct timeval Save_t;
4991 
4992 void
4994 {
4996  gettimeofday(&Save_t, NULL);
4997 }
4998 
4999 void
5000 ShowUsage(const char *title)
5001 {
5003  struct timeval user,
5004  sys;
5005  struct timeval elapse_t;
5006  struct rusage r;
5007 
5008  getrusage(RUSAGE_SELF, &r);
5009  gettimeofday(&elapse_t, NULL);
5010  memcpy((char *) &user, (char *) &r.ru_utime, sizeof(user));
5011  memcpy((char *) &sys, (char *) &r.ru_stime, sizeof(sys));
5012  if (elapse_t.tv_usec < Save_t.tv_usec)
5013  {
5014  elapse_t.tv_sec--;
5015  elapse_t.tv_usec += 1000000;
5016  }
5017  if (r.ru_utime.tv_usec < Save_r.ru_utime.tv_usec)
5018  {
5019  r.ru_utime.tv_sec--;
5020  r.ru_utime.tv_usec += 1000000;
5021  }
5022  if (r.ru_stime.tv_usec < Save_r.ru_stime.tv_usec)
5023  {
5024  r.ru_stime.tv_sec--;
5025  r.ru_stime.tv_usec += 1000000;
5026  }
5027 
5028  /*
5029  * The only stats we don't show here are ixrss, idrss, isrss. It takes
5030  * some work to interpret them, and most platforms don't fill them in.
5031  */
5032  initStringInfo(&str);
5033 
5034  appendStringInfoString(&str, "! system usage stats:\n");
5036  "!\t%ld.%06ld s user, %ld.%06ld s system, %ld.%06ld s elapsed\n",
5037  (long) (r.ru_utime.tv_sec - Save_r.ru_utime.tv_sec),
5038  (long) (r.ru_utime.tv_usec - Save_r.ru_utime.tv_usec),
5039  (long) (r.ru_stime.tv_sec - Save_r.ru_stime.tv_sec),
5040  (long) (r.ru_stime.tv_usec - Save_r.ru_stime.tv_usec),
5041  (long) (elapse_t.tv_sec - Save_t.tv_sec),
5042  (long) (elapse_t.tv_usec - Save_t.tv_usec));
5044  "!\t[%ld.%06ld s user, %ld.%06ld s system total]\n",
5045  (long) user.tv_sec,
5046  (long) user.tv_usec,
5047  (long) sys.tv_sec,
5048  (long) sys.tv_usec);
5049 #ifndef WIN32
5050 
5051  /*
5052  * The following rusage fields are not defined by POSIX, but they're
5053  * present on all current Unix-like systems so we use them without any
5054  * special checks. Some of these could be provided in our Windows
5055  * emulation in src/port/win32getrusage.c with more work.
5056  */
5058  "!\t%ld kB max resident size\n",
5059 #if defined(__darwin__)
5060  /* in bytes on macOS */
5061  r.ru_maxrss / 1024
5062 #else
5063  /* in kilobytes on most other platforms */
5064  r.ru_maxrss
5065 #endif
5066  );
5068  "!\t%ld/%ld [%ld/%ld] filesystem blocks in/out\n",
5069  r.ru_inblock - Save_r.ru_inblock,
5070  /* they only drink coffee at dec */
5071  r.ru_oublock - Save_r.ru_oublock,
5072  r.ru_inblock, r.ru_oublock);
5074  "!\t%ld/%ld [%ld/%ld] page faults/reclaims, %ld [%ld] swaps\n",
5075  r.ru_majflt - Save_r.ru_majflt,
5076  r.ru_minflt - Save_r.ru_minflt,
5077  r.ru_majflt, r.ru_minflt,
5078  r.ru_nswap - Save_r.ru_nswap,
5079  r.ru_nswap);
5081  "!\t%ld [%ld] signals rcvd, %ld/%ld [%ld/%ld] messages rcvd/sent\n",
5082  r.ru_nsignals - Save_r.ru_nsignals,
5083  r.ru_nsignals,
5084  r.ru_msgrcv - Save_r.ru_msgrcv,
5085  r.ru_msgsnd - Save_r.ru_msgsnd,
5086  r.ru_msgrcv, r.ru_msgsnd);
5088  "!\t%ld/%ld [%ld/%ld] voluntary/involuntary context switches\n",
5089  r.ru_nvcsw - Save_r.ru_nvcsw,
5090  r.ru_nivcsw - Save_r.ru_nivcsw,
5091  r.ru_nvcsw, r.ru_nivcsw);
5092 #endif /* !WIN32 */
5093 
5094  /* remove trailing newline */
5095  if (str.data[str.len - 1] == '\n')
5096  str.data[--str.len] = '\0';
5097 
5098  ereport(LOG,
5099  (errmsg_internal("%s", title),
5100  errdetail_internal("%s", str.data)));
5101 
5102  pfree(str.data);
5103 }
5104 
5105 /*
5106  * on_proc_exit handler to log end of session
5107  */
5108 static void
5110 {
5111  Port *port = MyProcPort;
5112  long secs;
5113  int usecs;
5114  int msecs;
5115  int hours,
5116  minutes,
5117  seconds;
5118 
5121  &secs, &usecs);
5122  msecs = usecs / 1000;
5123 
5124  hours = secs / SECS_PER_HOUR;
5125  secs %= SECS_PER_HOUR;
5126  minutes = secs / SECS_PER_MINUTE;
5127  seconds = secs % SECS_PER_MINUTE;
5128 
5129  ereport(LOG,
5130  (errmsg("disconnection: session time: %d:%02d:%02d.%03d "
5131  "user=%s database=%s host=%s%s%s",
5132  hours, minutes, seconds, msecs,
5133  port->user_name, port->database_name, port->remote_host,
5134  port->remote_port[0] ? " port=" : "", port->remote_port)));
5135 }
5136 
5137 /*
5138  * Start statement timeout timer, if enabled.
5139  *
5140  * If there's already a timeout running, don't restart the timer. That
5141  * enables compromises between accuracy of timeouts and cost of starting a
5142  * timeout.
5143  */
5144 static void
5146 {
5147  /* must be within an xact */
5149 
5150  if (StatementTimeout > 0
5152  {
5155  }
5156  else
5157  {
5160  }
5161 }
5162 
5163 /*
5164  * Disable statement timeout, if active.
5165  */
5166 static void
5168 {
5171 }
Datum querytree(PG_FUNCTION_ARGS)
Definition: _int_bool.c:666
volatile sig_atomic_t ParallelApplyMessagePending
void HandleParallelApplyMessages(void)
void ProcessNotifyInterrupt(bool flush)
Definition: async.c:1834
volatile sig_atomic_t notifyInterruptPending
Definition: async.c:413
void HandleParallelMessages(void)
Definition: parallel.c:1027
volatile sig_atomic_t ParallelMessagePending
Definition: parallel.c:115
void DropPreparedStatement(const char *stmt_name, bool showError)
Definition: prepare.c:516
PreparedStatement * FetchPreparedStatement(const char *stmt_name, bool throwError)
Definition: prepare.c:431
void StorePreparedStatement(const char *stmt_name, CachedPlanSource *plansource, bool from_sql)
Definition: prepare.c:389
sigset_t UnBlockSig
Definition: pqsignal.c:22
sigset_t BlockSig
Definition: pqsignal.c:23
void elog_node_display(int lev, const char *title, const void *obj, bool pretty)
Definition: print.c:72
List * raw_parser(const char *str, RawParseMode mode)
Definition: parser.c:42
bool IsLogicalWorker(void)
Definition: worker.c:4744
void TimestampDifference(TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
Definition: timestamp.c:1730
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1654
TimestampTz PgStartTime
Definition: timestamp.c:52
void pgstat_report_query_id(uint64 query_id, bool force)
void pgstat_report_activity(BackendState state, const char *cmd_str)
@ STATE_IDLEINTRANSACTION_ABORTED
@ STATE_IDLE
@ STATE_IDLEINTRANSACTION
@ STATE_FASTPATH
@ STATE_RUNNING
bool HoldingBufferPinThatDelaysRecovery(void)
Definition: bufmgr.c:5010
#define unconstify(underlying_type, expr)
Definition: c.h:1232
signed short int16
Definition: c.h:480
signed int int32
Definition: c.h:481
#define SIGNAL_ARGS
Definition: c.h:1332
#define unlikely(x)
Definition: c.h:298
const char * GetCommandTagNameAndLen(CommandTag commandTag, Size *len)
Definition: cmdtag.c:53
CommandTag
Definition: cmdtag.h:23
#define __darwin__
Definition: darwin.h:3
#define SECS_PER_HOUR
Definition: timestamp.h:127
#define SECS_PER_MINUTE
Definition: timestamp.h:128
void EndCommand(const QueryCompletion *qc, CommandDest dest, bool force_undecorated_output)
Definition: dest.c:165
void BeginCommand(CommandTag commandTag, CommandDest dest)
Definition: dest.c:102
void ReadyForQuery(CommandDest dest)
Definition: dest.c:250
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:112
void NullCommand(CommandDest dest)
Definition: dest.c:213
CommandDest
Definition: dest.h:86
@ DestRemote
Definition: dest.h:89
@ DestDebug
Definition: dest.h:88
@ DestRemoteExecute
Definition: dest.h:90
@ DestNone
Definition: dest.h:87
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1159
int errhidestmt(bool hide_stmt)
Definition: elog.c:1413
void EmitErrorReport(void)
Definition: elog.c:1672
int errdetail_internal(const char *fmt,...)
Definition: elog.c:1232
int errdetail(const char *fmt,...)
Definition: elog.c:1205
ErrorContextCallback * error_context_stack
Definition: elog.c:94
void FlushErrorState(void)
Definition: elog.c:1828
int errhint(const char *fmt,...)
Definition: elog.c:1319
int errcode(int sqlerrcode)
Definition: elog.c:859
int errmsg(const char *fmt,...)
Definition: elog.c:1072
#define _(x)
Definition: elog.c:90
sigjmp_buf * PG_exception_stack
Definition: elog.c:96
#define LOG
Definition: elog.h:31
#define errcontext
Definition: elog.h:196
#define COMMERROR
Definition: elog.h:33
#define WARNING_CLIENT_ONLY
Definition: elog.h:38
#define FATAL
Definition: elog.h:41
#define WARNING
Definition: elog.h:36
#define DEBUG2
Definition: elog.h:29
#define DEBUG1
Definition: elog.h:30
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:224
#define ereport(elevel,...)
Definition: elog.h:149
bool equal(const void *a, const void *b)
Definition: equalfuncs.c:223
void EventTriggerOnLogin(void)
void HandleFunctionRequest(StringInfo msgBuf)
Definition: fastpath.c:189
#define palloc_array(type, count)
Definition: fe_memutils.h:64
#define palloc0_array(type, count)
Definition: fe_memutils.h:65
Datum OidReceiveFunctionCall(Oid functionId, StringInfo buf, Oid typioparam, int32 typmod)
Definition: fmgr.c:1772
Datum OidInputFunctionCall(Oid functionId, char *str, Oid typioparam, int32 typmod)
Definition: fmgr.c:1754
volatile sig_atomic_t IdleStatsUpdateTimeoutPending
Definition: globals.c:40
volatile sig_atomic_t LogMemoryContextPending
Definition: globals.c:39
volatile sig_atomic_t ProcSignalBarrierPending
Definition: globals.c:38
volatile sig_atomic_t InterruptPending
Definition: globals.c:30
volatile sig_atomic_t IdleSessionTimeoutPending
Definition: globals.c:37
bool IsBinaryUpgrade
Definition: globals.c:118
volatile uint32 QueryCancelHoldoffCount
Definition: globals.c:42
int32 MyCancelKey
Definition: globals.c:50
ProtocolVersion FrontendProtocol
Definition: globals.c:28
volatile sig_atomic_t IdleInTransactionSessionTimeoutPending
Definition: globals.c:35
volatile uint32 InterruptHoldoffCount
Definition: globals.c:41
volatile sig_atomic_t TransactionTimeoutPending
Definition: globals.c:36
int MyProcPid
Definition: globals.c:45
bool IsUnderPostmaster
Definition: globals.c:117
volatile sig_atomic_t ClientConnectionLost
Definition: globals.c:34
volatile uint32 CritSectionCount
Definition: globals.c:43
volatile sig_atomic_t QueryCancelPending
Definition: globals.c:31
TimestampTz MyStartTimestamp
Definition: globals.c:47
struct Port * MyProcPort
Definition: globals.c:49
struct Latch * MyLatch
Definition: globals.c:60
char OutputFileName[MAXPGPATH]
Definition: globals.c:76
volatile sig_atomic_t ProcDiePending
Definition: globals.c:32
volatile sig_atomic_t CheckClientConnectionPending
Definition: globals.c:33
Oid MyDatabaseId
Definition: globals.c:91
void BeginReportingGUCOptions(void)
Definition: guc.c:2548
void SetConfigOption(const char *name, const char *value, GucContext context, GucSource source)
Definition: guc.c:4275
#define newval
bool SelectConfigFiles(const char *userDoption, const char *progname)
Definition: guc.c:1786
void ParseLongOption(const char *string, char **name, char **value)
Definition: guc.c:6306
void InitializeGUCOptions(void)
Definition: guc.c:1532
void ReportChangedGUCOptions(void)
Definition: guc.c:2598
#define GUC_check_errdetail
Definition: guc.h:447
GucSource
Definition: guc.h:108
@ PGC_S_ARGV
Definition: guc.h:113
@ PGC_S_CLIENT
Definition: guc.h:118
GucContext
Definition: guc.h:68
@ PGC_POSTMASTER
Definition: guc.h:70
@ PGC_SIGHUP
Definition: guc.h:71
#define GUC_check_errhint
Definition: guc.h:451
void ProcessConfigFile(GucContext context)
bool log_statement_stats
Definition: guc_tables.c:506
bool Debug_print_plan
Definition: guc_tables.c:498
bool log_parser_stats
Definition: guc_tables.c:503
bool Debug_pretty_print
Definition: guc_tables.c:501
int log_parameter_max_length_on_error
Definition: guc_tables.c:527
int log_min_duration_statement
Definition: guc_tables.c:525
int log_min_duration_sample
Definition: guc_tables.c:524
bool log_planner_stats
Definition: guc_tables.c:504
bool Debug_print_rewritten
Definition: guc_tables.c:500
bool Debug_print_parse
Definition: guc_tables.c:499
int log_parameter_max_length
Definition: guc_tables.c:526
double log_statement_sample_rate
Definition: guc_tables.c:529
bool log_duration
Definition: guc_tables.c:497
bool log_executor_stats
Definition: guc_tables.c:505
#define stmt
Definition: indent_codes.h:59
long val
Definition: informix.c:664
static struct @150 value
#define INJECTION_POINT(name)
volatile sig_atomic_t ConfigReloadPending
Definition: interrupt.c:27
void SignalHandlerForConfigReload(SIGNAL_ARGS)
Definition: interrupt.c:61
void on_proc_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:309
bool proc_exit_inprogress
Definition: ipc.c:40
void proc_exit(int code)
Definition: ipc.c:104
void InitializeShmemGUCs(void)
Definition: ipci.c:369
void CreateSharedMemoryAndSemaphores(void)
Definition: ipci.c:199
int i
Definition: isn.c:73
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:77
void jit_reset_after_error(void)
Definition: jit.c:127
void SetLatch(Latch *latch)
Definition: latch.c:632
bool WaitEventSetCanReportClosed(void)
Definition: latch.c:2215
bool IsLogicalLauncher(void)
Definition: launcher.c:1243
#define pq_flush()
Definition: libpq.h:46
#define pq_comm_reset()
Definition: libpq.h:45
#define PQ_SMALL_MESSAGE_LIMIT
Definition: libpq.h:30
#define PQ_LARGE_MESSAGE_LIMIT
Definition: libpq.h:31
static void const char fflush(stdout)
Assert(fmt[strlen(fmt) - 1] !='\n')
static List * new_list(NodeTag type, int min_size)
Definition: list.c:91
List * lappend(List *list, void *datum)
Definition: list.c:339
void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam)
Definition: lsyscache.c:2830
void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam)
Definition: lsyscache.c:2896
const char * progname
Definition: main.c:44
char * pg_client_to_server(const char *s, int len)
Definition: mbutils.c:660
char * pnstrdup(const char *in, Size len)
Definition: mcxt.c:1694
MemoryContext MessageContext
Definition: mcxt.c:141
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:371
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:625
char * pstrdup(const char *in)
Definition: mcxt.c:1683
void pfree(void *pointer)
Definition: mcxt.c:1508
MemoryContext TopMemoryContext
Definition: mcxt.c:137
void MemoryContextStats(MemoryContext context)
Definition: mcxt.c:802
MemoryContext PostmasterContext
Definition: mcxt.c:139
void ProcessLogMemoryContextInterrupt(void)
Definition: mcxt.c:1276
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:442
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:153
#define RESUME_INTERRUPTS()
Definition: miscadmin.h:135
@ NormalProcessing
Definition: miscadmin.h:446
@ InitProcessing
Definition: miscadmin.h:445
#define HOLD_CANCEL_INTERRUPTS()
Definition: miscadmin.h:141
#define INIT_PG_LOAD_SESSION_LIBS
Definition: miscadmin.h:473
#define AmAutoVacuumWorkerProcess()
Definition: miscadmin.h:372
#define RESUME_CANCEL_INTERRUPTS()
Definition: miscadmin.h:143
#define AmBackgroundWorkerProcess()
Definition: miscadmin.h:373
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
#define HOLD_INTERRUPTS()
Definition: miscadmin.h:133
#define SetProcessingMode(mode)
Definition: miscadmin.h:457
char * pg_stack_base_t
Definition: miscadmin.h:296
void ChangeToDataDir(void)
Definition: miscinit.c:454
void process_shmem_requests(void)
Definition: miscinit.c:1871
void InitStandaloneProcess(const char *argv0)
Definition: miscinit.c:181
void process_shared_preload_libraries(void)
Definition: miscinit.c:1843
void checkDataDir(void)
Definition: miscinit.c:341
void CreateDataDirLockFile(bool amPostmaster)
Definition: miscinit.c:1455
#define IsA(nodeptr, _type_)
Definition: nodes.h:158
#define copyObject(obj)
Definition: nodes.h:223
@ CMD_UTILITY
Definition: nodes.h:260
#define makeNode(_type_)
Definition: nodes.h:155
char * nodeToString(const void *obj)
Definition: outfuncs.c:763
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:124
ParamListInfo makeParamList(int numParams)
Definition: params.c:44
char * BuildParamLogString(ParamListInfo params, char **knownTextValues, int maxlen)
Definition: params.c:335
void ParamsErrorCallback(void *arg)
Definition: params.c:407
#define PARAM_FLAG_CONST
Definition: params.h:88
void(* ParserSetupHook)(struct ParseState *pstate, void *arg)
Definition: params.h:108
@ TRANS_STMT_ROLLBACK_TO
Definition: parsenodes.h:3515
@ TRANS_STMT_ROLLBACK
Definition: parsenodes.h:3512
@ TRANS_STMT_COMMIT
Definition: parsenodes.h:3511
@ TRANS_STMT_PREPARE
Definition: parsenodes.h:3516
#define FETCH_ALL
Definition: parsenodes.h:3179
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:3144
#define CURSOR_OPT_BINARY
Definition: parsenodes.h:3134
Query * parse_analyze_withcb(RawStmt *parseTree, const char *sourceText, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: analyze.c:185
bool analyze_requires_snapshot(RawStmt *parseTree)
Definition: analyze.c:485
Query * parse_analyze_varparams(RawStmt *parseTree, const char *sourceText, Oid **paramTypes, int *numParams, QueryEnvironment *queryEnv)
Definition: analyze.c:144
Query * parse_analyze_fixedparams(RawStmt *parseTree, const char *sourceText, const Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: analyze.c:104
@ RAW_PARSE_DEFAULT
Definition: parser.h:39
void * arg
static char format
#define MAXPGPATH
const void * data
PGDLLIMPORT int optind
Definition: getopt.c:50
PGDLLIMPORT int opterr
Definition: getopt.c:49
int getopt(int nargc, char *const *nargv, const char *ostr)
Definition: getopt.c:71
PGDLLIMPORT char * optarg
Definition: getopt.c:52
#define lfirst(lc)
Definition: pg_list.h:172
#define lfirst_node(type, lc)
Definition: pg_list.h:176
static int list_length(const List *l)
Definition: pg_list.h:152
#define linitial_node(type, l)
Definition: pg_list.h:181
#define NIL
Definition: pg_list.h:68
#define list_make1(x1)
Definition: pg_list.h:212
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:343
double pg_prng_double(pg_prng_state *state)
Definition: pg_prng.c:232
pg_prng_state pg_global_prng_state
Definition: pg_prng.c:34
#define plan(x)
Definition: pg_regress.c:162
static char * user
Definition: pg_regress.c:120
static int port
Definition: pg_regress.c:116
static rewind_source * source
Definition: pg_rewind.c:89
static char * buf
Definition: pg_test_fsync.c:73
#define MAX_MULTIBYTE_CHAR_LEN
Definition: pg_wchar.h:33
#define ERRCODE_T_R_SERIALIZATION_FAILURE
Definition: pgbench.c:76
const char * username
Definition: pgbench.c:296
long pgstat_report_stat(bool force)
Definition: pgstat.c:579
@ DISCONNECT_KILLED
Definition: pgstat.h:82
@ DISCONNECT_CLIENT_EOF
Definition: pgstat.h:80
void pgstat_report_connect(Oid dboid)
void pgstat_report_recovery_conflict(int reason)
SessionEndType pgStatSessionEndCause
void DropCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:526
List * CachedPlanGetTargetList(CachedPlanSource *plansource, QueryEnvironment *queryEnv)
Definition: plancache.c:1640
void SaveCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:482
void CompleteCachedPlan(CachedPlanSource *plansource, List *querytree_list, MemoryContext querytree_context, Oid *param_types, int num_params, ParserSetupHook parserSetup, void *parserSetupArg, int cursor_options, bool fixed_result)
Definition: plancache.c:366
CachedPlanSource * CreateCachedPlan(RawStmt *raw_parse_tree, const char *query_string, CommandTag commandTag)
Definition: plancache.c:192
CachedPlan * GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, ResourceOwner owner, QueryEnvironment *queryEnv)
Definition: plancache.c:1168
PlannedStmt * planner(Query *parse, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: planner.c:268
QuitSignalReason GetQuitSignalReason(void)
Definition: pmsignal.c:229
@ PMQUIT_FOR_STOP
Definition: pmsignal.h:54
@ PMQUIT_FOR_CRASH
Definition: pmsignal.h:53
@ PMQUIT_NOT_SENT
Definition: pmsignal.h:52
#define sprintf
Definition: port.h:240
pqsigfunc pqsignal(int signo, pqsigfunc func)
#define snprintf
Definition: port.h:238
#define printf(...)
Definition: port.h:244
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
#define PortalIsValid(p)
Definition: portal.h:212
void PortalDrop(Portal portal, bool isTopCommit)
Definition: portalmem.c:468
Portal GetPortalByName(const char *name)
Definition: portalmem.c:130
void PortalDefineQuery(Portal portal, const char *prepStmtName, const char *sourceText, CommandTag commandTag, List *stmts, CachedPlan *cplan)
Definition: portalmem.c:282
Portal CreatePortal(const char *name, bool allowDup, bool dupSilent)
Definition: portalmem.c:175
void PortalErrorCleanup(void)
Definition: portalmem.c:917
static int errdetail_recovery_conflict(ProcSignalReason reason)
Definition: postgres.c:2509
struct BindParamCbData BindParamCbData
static void disable_statement_timeout(void)
Definition: postgres.c:5167
int log_statement
Definition: postgres.c:95
List * pg_parse_query(const char *query_string)
Definition: postgres.c:611
static bool IsTransactionStmtList(List *pstmts)
Definition: postgres.c:2835
void assign_transaction_timeout(int newval, void *extra)
Definition: postgres.c:3656
static bool check_log_statement(List *stmt_list)
Definition: postgres.c:2340
static void exec_describe_statement_message(const char *stmt_name)
Definition: postgres.c:2597
void process_postgres_switches(int argc, char *argv[], GucContext ctx, const char **dbname)
Definition: postgres.c:3790
void restore_stack_base(pg_stack_base_t base)
Definition: postgres.c:3514
int PostAuthDelay
Definition: postgres.c:101
void quickdie(SIGNAL_ARGS)
Definition: postgres.c:2875
static bool IsTransactionExitStmtList(List *pstmts)
Definition: postgres.c:2820
static void log_disconnections(int code, Datum arg)
Definition: postgres.c:5109
static int errdetail_abort(void)
Definition: postgres.c:2495
int max_stack_depth
Definition: postgres.c:98
static void forbidden_in_wal_sender(char firstchar)
Definition: postgres.c:4939
static void exec_execute_message(const char *portal_name, long max_rows)
Definition: postgres.c:2085
bool check_max_stack_depth(int *newval, void **extra, GucSource source)
Definition: postgres.c:3578
void PostgresSingleUserMain(int argc, char *argv[], const char *username)
Definition: postgres.c:4042
void set_debug_options(int debug_flag, GucContext context, GucSource source)
Definition: postgres.c:3679
static bool UseSemiNewlineNewline
Definition: postgres.c:163
static CachedPlanSource * unnamed_stmt_psrc
Definition: postgres.c:158
void FloatExceptionHandler(SIGNAL_ARGS)
Definition: postgres.c:3019
int client_connection_check_interval
Definition: postgres.c:104
bool check_log_stats(bool *newval, void **extra, GucSource source)
Definition: postgres.c:3641
static bool EchoQuery
Definition: postgres.c:162
void StatementCancelHandler(SIGNAL_ARGS)
Definition: postgres.c:3002
CommandDest whereToSendOutput
Definition: postgres.c:90
long get_stack_depth_rlimit(void)
Definition: postgres.c:4961
static bool ignore_till_sync
Definition: postgres.c:151
static void finish_xact_command(void)
Definition: postgres.c:2771
bool set_plan_disabling_options(const char *arg, GucContext context, GucSource source)
Definition: postgres.c:3708
static void enable_statement_timeout(void)
Definition: postgres.c:5145
static long max_stack_depth_bytes
Definition: postgres.c:125
int check_log_duration(char *msec_str, bool was_logged)
Definition: postgres.c:2379
static struct timeval Save_t
Definition: postgres.c:4990
const char * debug_query_string
Definition: postgres.c:87
static void exec_simple_query(const char *query_string)
Definition: postgres.c:1013
List * pg_analyze_and_rewrite_varparams(RawStmt *parsetree, const char *query_string, Oid **paramTypes, int *numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:710
void HandleRecoveryConflictInterrupt(ProcSignalReason reason)
Definition: postgres.c:3035
static volatile sig_atomic_t RecoveryConflictPendingReasons[NUM_PROCSIGNALS]
Definition: postgres.c:167
static int errdetail_execute(List *raw_parsetree_list)
Definition: postgres.c:2442
List * pg_analyze_and_rewrite_withcb(RawStmt *parsetree, const char *query_string, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: postgres.c:764
void ShowUsage(const char *title)
Definition: postgres.c:5000
static void exec_parse_message(const char *query_string, const char *stmt_name, Oid *paramTypes, int numParams)
Definition: postgres.c:1391
List * pg_analyze_and_rewrite_fixedparams(RawStmt *parsetree, const char *query_string, const Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:671
static const char * userDoption
Definition: postgres.c:161
static volatile sig_atomic_t RecoveryConflictPending
Definition: postgres.c:166
static void exec_bind_message(StringInfo input_message)
Definition: postgres.c:1626
static bool DoingCommandRead
Definition: postgres.c:144
List * pg_rewrite_query(Query *query)
Definition: postgres.c:804
void die(SIGNAL_ARGS)
Definition: postgres.c:2972
const char * get_stats_option_name(const char *arg)
Definition: postgres.c:3750
static bool xact_started
Definition: postgres.c:137
static int interactive_getc(void)
Definition: postgres.c:332
bool stack_is_too_deep(void)
Definition: postgres.c:3545
static int errdetail_params(ParamListInfo params)
Definition: postgres.c:2475
static void ProcessRecoveryConflictInterrupts(void)
Definition: postgres.c:3205
static int SocketBackend(StringInfo inBuf)
Definition: postgres.c:360
void ProcessClientReadInterrupt(bool blocked)
Definition: postgres.c:509
void assign_max_stack_depth(int newval, void *extra)
Definition: postgres.c:3595
void ProcessInterrupts(void)
Definition: postgres.c:3244
static void bind_param_error_callback(void *arg)
Definition: postgres.c:2548
static bool IsTransactionExitStmt(Node *parsetree)
Definition: postgres.c:2803
PlannedStmt * pg_plan_query(Query *querytree, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:886
void PostgresMain(const char *dbname, const char *username)
Definition: postgres.c:4152
static MemoryContext row_description_context
Definition: postgres.c:170
static int InteractiveBackend(StringInfo inBuf)
Definition: postgres.c:244
static void ProcessRecoveryConflictInterrupt(ProcSignalReason reason)
Definition: postgres.c:3047
static char * stack_base_ptr
Definition: postgres.c:131
static struct rusage Save_r
Definition: postgres.c:4989
bool check_client_connection_check_interval(int *newval, void **extra, GucSource source)
Definition: postgres.c:3606
static StringInfoData row_description_buf
Definition: postgres.c:171
void ProcessClientWriteInterrupt(bool blocked)
Definition: postgres.c:555
static bool doing_extended_query_message
Definition: postgres.c:150
void ResetUsage(void)
Definition: postgres.c:4993
static void start_xact_command(void)
Definition: postgres.c:2743
List * pg_plan_queries(List *querytrees, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:972
static void exec_describe_portal_message(const char *portal_name)
Definition: postgres.c:2691
void check_stack_depth(void)
Definition: postgres.c:3531
bool Log_disconnections
Definition: postgres.c:93
pg_stack_base_t set_stack_base(void)
Definition: postgres.c:3481
static void drop_unnamed_stmt(void)
Definition: postgres.c:2850
#define valgrind_report_error_query(query)
Definition: postgres.c:224
static int ReadCommand(StringInfo inBuf)
Definition: postgres.c:488
bool check_stage_log_stats(bool *newval, void **extra, GucSource source)
Definition: postgres.c:3627
uintptr_t Datum
Definition: postgres.h:64
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
void InitializeMaxBackends(void)
Definition: postinit.c:575
void BaseInit(void)
Definition: postinit.c:645
void InitPostgres(const char *in_dbname, Oid dboid, const char *username, Oid useroid, bits32 flags, char *out_dbname)
Definition: postinit.c:736
bool ClientAuthInProgress
Definition: postmaster.c:350
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:185
int pq_getmessage(StringInfo s, int maxlen)
Definition: pqcomm.c:1198
int pq_getbyte(void)
Definition: pqcomm.c:961
bool pq_is_reading_msg(void)
Definition: pqcomm.c:1176
bool pq_check_connection(void)
Definition: pqcomm.c:2019
void pq_startmsgread(void)
Definition: pqcomm.c:1136
uint32 ProtocolVersion
Definition: pqcomm.h:99
unsigned int pq_getmsgint(StringInfo msg, int b)
Definition: pqformat.c:415
const char * pq_getmsgstring(StringInfo msg)
Definition: pqformat.c:579
void pq_getmsgend(StringInfo msg)
Definition: pqformat.c:635
const char * pq_getmsgbytes(StringInfo msg, int datalen)
Definition: pqformat.c:508
void pq_putemptymessage(char msgtype)
Definition: pqformat.c:388
void pq_endmessage(StringInfo buf)
Definition: pqformat.c:296
int pq_getmsgbyte(StringInfo msg)
Definition: pqformat.c:399
void pq_beginmessage(StringInfo buf, char msgtype)
Definition: pqformat.c:88
void pq_beginmessage_reuse(StringInfo buf, char msgtype)
Definition: pqformat.c:109
void pq_endmessage_reuse(StringInfo buf)
Definition: pqformat.c:314
static void pq_sendint32(StringInfo buf, uint32 i)
Definition: pqformat.h:144
static void pq_sendint16(StringInfo buf, uint16 i)
Definition: pqformat.h:136
void PortalSetResultFormat(Portal portal, int nFormats, int16 *formats)
Definition: pquery.c:623
void PortalStart(Portal portal, ParamListInfo params, int eflags, Snapshot snapshot)
Definition: pquery.c:433
bool PortalRun(Portal portal, long count, bool isTopLevel, bool run_once, DestReceiver *dest, DestReceiver *altdest, QueryCompletion *qc)
Definition: pquery.c:684
List * FetchPortalTargetList(Portal portal)
Definition: pquery.c:326
char * c
void SetRemoteDestReceiverParams(DestReceiver *self, Portal portal)
Definition: printtup.c:99
void SendRowDescriptionMessage(StringInfo buf, TupleDesc typeinfo, List *targetlist, int16 *formats)
Definition: printtup.c:165
void ProcessProcSignalBarrier(void)
Definition: procsignal.c:464
void procsignal_sigusr1_handler(SIGNAL_ARGS)
Definition: procsignal.c:635
ProcSignalReason
Definition: procsignal.h:31
@ PROCSIG_RECOVERY_CONFLICT_BUFFERPIN
Definition: procsignal.h:47
@ PROCSIG_RECOVERY_CONFLICT_LOCK
Definition: procsignal.h:44
@ PROCSIG_RECOVERY_CONFLICT_LOGICALSLOT
Definition: procsignal.h:46
@ PROCSIG_RECOVERY_CONFLICT_DATABASE
Definition: procsignal.h:42
@ PROCSIG_RECOVERY_CONFLICT_SNAPSHOT
Definition: procsignal.h:45
@ PROCSIG_RECOVERY_CONFLICT_LAST
Definition: procsignal.h:49
@ PROCSIG_RECOVERY_CONFLICT_FIRST
Definition: procsignal.h:41
@ PROCSIG_RECOVERY_CONFLICT_TABLESPACE
Definition: procsignal.h:43
@ NUM_PROCSIGNALS
Definition: procsignal.h:51
@ PROCSIG_RECOVERY_CONFLICT_STARTUP_DEADLOCK
Definition: procsignal.h:48
#define PqMsg_CloseComplete
Definition: protocol.h:40
#define PqMsg_CopyDone
Definition: protocol.h:64
#define PqMsg_BindComplete
Definition: protocol.h:39
#define PqMsg_CopyData
Definition: protocol.h:65
#define PqMsg_FunctionCall
Definition: protocol.h:23
#define PqMsg_Describe
Definition: protocol.h:21
#define PqMsg_NoData
Definition: protocol.h:56
#define PqMsg_PortalSuspended
Definition: protocol.h:57
#define PqMsg_Parse
Definition: protocol.h:25
#define PqMsg_Bind
Definition: protocol.h:19
#define PqMsg_Sync
Definition: protocol.h:27
#define PqMsg_CopyFail
Definition: protocol.h:29
#define PqMsg_Flush
Definition: protocol.h:24
#define PqMsg_BackendKeyData
Definition: protocol.h:48
#define PqMsg_Query
Definition: protocol.h:26
#define PqMsg_Terminate
Definition: protocol.h:28
#define PqMsg_Execute
Definition: protocol.h:22
#define PqMsg_Close
Definition: protocol.h:20
#define PqMsg_ParseComplete
Definition: protocol.h:38
void set_ps_display_with_len(const char *activity, size_t len)
Definition: ps_status.c:424
static void set_ps_display(const char *activity)
Definition: ps_status.h:40
int getrusage(int who, struct rusage *rusage)
#define RUSAGE_SELF
Definition: resource.h:9
List * QueryRewrite(Query *parsetree)
void ProcessCatchupInterrupt(void)
Definition: sinval.c:174
volatile sig_atomic_t catchupInterruptPending
Definition: sinval.c:39
void ReplicationSlotCleanup(void)
Definition: slot.c:719
ReplicationSlot * MyReplicationSlot
Definition: slot.c:138
void ReplicationSlotRelease(void)
Definition: slot.c:643
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:216
void PushActiveSnapshot(Snapshot snapshot)
Definition: snapmgr.c:648
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:782
void InvalidateCatalogSnapshotConditionally(void)
Definition: snapmgr.c:443
void PopActiveSnapshot(void)
Definition: snapmgr.c:743
#define InvalidSnapshot
Definition: snapshot.h:123
int IdleSessionTimeout
Definition: proc.c:62
PGPROC * MyProc
Definition: proc.c:66
bool IsWaitingForLock(void)
Definition: proc.c:713
int StatementTimeout
Definition: proc.c:58
int IdleInTransactionSessionTimeout
Definition: proc.c:60
int GetStartupBufferPinWaitBufId(void)
Definition: proc.c:671
int TransactionTimeout
Definition: proc.c:61
void LockErrorCleanup(void)
Definition: proc.c:730
void InitProcess(void)
Definition: proc.c:296
void CheckDeadLockAlert(void)
Definition: proc.c:1840
char * dbname
Definition: streamutil.c:51
void resetStringInfo(StringInfo str)
Definition: stringinfo.c:78
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:97
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:182
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:194
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
static void initReadOnlyStringInfo(StringInfo str, char *data, int len)
Definition: stringinfo.h:130
void appendStringInfoStringQuoted(StringInfo str, const char *s, int maxlen)
Definition: stringinfo_mb.c:34
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:92
const char * portalName
Definition: postgres.c:114
const char * paramval
Definition: postgres.c:116
CommandTag commandTag
Definition: plancache.h:101
MemoryContext context
Definition: plancache.h:109
const char * query_string
Definition: plancache.h:100
struct RawStmt * raw_parse_tree
Definition: plancache.h:99
TupleDesc resultDesc
Definition: plancache.h:108
List * stmt_list
Definition: plancache.h:150
struct ErrorContextCallback * previous
Definition: elog.h:295
void(* callback)(void *arg)
Definition: elog.h:296
Definition: pg_list.h:54
Definition: nodes.h:129
bool recoveryConflictPending
Definition: proc.h:216
bool isnull
Definition: params.h:93
uint16 pflags
Definition: params.h:94
Datum value
Definition: params.h:92
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
char * paramValuesStr
Definition: params.h:118
ParamListInfo params
Definition: params.h:157
const char * portalName
Definition: params.h:156
CmdType commandType
Definition: plannodes.h:52
Node * utilityStmt
Definition: plannodes.h:95
Definition: libpq-be.h:133
CommandTag commandTag
Definition: portal.h:137
const char * sourceText
Definition: portal.h:136
bool atStart
Definition: portal.h:199
List * stmts
Definition: portal.h:139
MemoryContext portalContext
Definition: portal.h:120
int16 * formats
Definition: portal.h:162
ParamListInfo portalParams
Definition: portal.h:142
bool visible
Definition: portal.h:205
const char * name
Definition: portal.h:118
const char * prepStmtName
Definition: portal.h:119
TupleDesc tupDesc
Definition: portal.h:160
int cursorOptions
Definition: portal.h:147
CachedPlanSource * plansource
Definition: prepare.h:31
int stmt_location
Definition: parsenodes.h:237
CmdType commandType
Definition: parsenodes.h:121
Node * utilityStmt
Definition: parsenodes.h:136
Node * stmt
Definition: parsenodes.h:1873
void(* rDestroy)(DestReceiver *self)
Definition: dest.h:125
struct timeval ru_utime
Definition: resource.h:14
struct timeval ru_stime
Definition: resource.h:15
#define STACK_DEPTH_SLOP
Definition: tcopprot.h:25
@ LOGSTMT_NONE
Definition: tcopprot.h:37
@ LOGSTMT_ALL
Definition: tcopprot.h:40
char * flag(int b)
Definition: test-ctype.c:33
void enable_timeout_after(TimeoutId id, int delay_ms)
Definition: timeout.c:560
bool get_timeout_active(TimeoutId id)
Definition: timeout.c:780
void disable_all_timeouts(bool keep_indicators)
Definition: timeout.c:751
TimestampTz get_timeout_finish_time(TimeoutId id)
Definition: timeout.c:827
void InitializeTimeouts(void)
Definition: timeout.c:470
void disable_timeout(TimeoutId id, bool keep_indicator)
Definition: timeout.c:685
bool get_timeout_indicator(TimeoutId id, bool reset_indicator)
Definition: timeout.c:793
@ IDLE_SESSION_TIMEOUT
Definition: timeout.h:35
@ IDLE_IN_TRANSACTION_SESSION_TIMEOUT
Definition: timeout.h:33
@ LOCK_TIMEOUT
Definition: timeout.h:28
@ STATEMENT_TIMEOUT
Definition: timeout.h:29
@ TRANSACTION_TIMEOUT
Definition: timeout.h:34
@ IDLE_STATS_UPDATE_TIMEOUT
Definition: timeout.h:36
@ CLIENT_CONNECTION_CHECK_TIMEOUT
Definition: timeout.h:37
CommandTag CreateCommandTag(Node *parsetree)
Definition: utility.c:2359
LogStmtLevel GetCommandLogLevel(Node *parsetree)
Definition: utility.c:3246
const char * name
void WalSndErrorCleanup(void)
Definition: walsender.c:327
bool am_walsender
Definition: walsender.c:115
bool exec_replication_command(const char *cmd_string)
Definition: walsender.c:1977
void WalSndSignals(void)
Definition: walsender.c:3590
void InitWalSender(void)
#define SIGCHLD
Definition: win32_port.h:178
#define SIGHUP
Definition: win32_port.h:168
#define SIG_DFL
Definition: win32_port.h:163
#define SIGPIPE
Definition: win32_port.h:173
#define SIGQUIT
Definition: win32_port.h:169
#define SIGUSR1
Definition: win32_port.h:180
#define SIGUSR2
Definition: win32_port.h:181
#define SIG_IGN
Definition: win32_port.h:165
int gettimeofday(struct timeval *tp, void *tzp)
bool IsTransactionOrTransactionBlock(void)
Definition: xact.c:4910
void BeginImplicitTransactionBlock(void)
Definition: xact.c:4248
bool IsTransactionState(void)
Definition: xact.c:379
void CommandCounterIncrement(void)
Definition: xact.c:1079
void StartTransactionCommand(void)
Definition: xact.c:2955
bool IsAbortedTransactionBlockState(void)
Definition: xact.c:399
void EndImplicitTransactionBlock(void)
Definition: xact.c:4273
bool IsSubTransaction(void)
Definition: xact.c:4965
void SetCurrentStatementStartTimestamp(void)
Definition: xact.c:900
TimestampTz GetCurrentStatementStartTimestamp(void)
Definition: xact.c:865
void CommitTransactionCommand(void)
Definition: xact.c:3053
bool xact_is_sampled
Definition: xact.c:288
int MyXactFlags
Definition: xact.c:134
void AbortCurrentTransaction(void)
Definition: xact.c:3351
#define XACT_FLAGS_PIPELINING
Definition: xact.h:121
#define XACT_FLAGS_NEEDIMMEDIATECOMMIT
Definition: xact.h:114
void InitializeWalConsistencyChecking(void)
Definition: xlog.c:4674
void LocalProcessControlFile(bool reset)
Definition: xlog.c:4736