PostgreSQL Source Code git master
Loading...
Searching...
No Matches
explain.c
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * explain.c
4 * Explain query execution plans
5 *
6 * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994-5, Regents of the University of California
8 *
9 * IDENTIFICATION
10 * src/backend/commands/explain.c
11 *
12 *-------------------------------------------------------------------------
13 */
14#include "postgres.h"
15
16#include "access/xact.h"
17#include "catalog/pg_type.h"
18#include "commands/createas.h"
19#include "commands/defrem.h"
20#include "commands/explain.h"
21#include "commands/explain_dr.h"
22#include "commands/explain_format.h"
23#include "commands/explain_state.h"
24#include "commands/prepare.h"
25#include "foreign/fdwapi.h"
26#include "jit/jit.h"
27#include "libpq/pqformat.h"
28#include "libpq/protocol.h"
29#include "nodes/extensible.h"
30#include "nodes/makefuncs.h"
31#include "nodes/nodeFuncs.h"
32#include "parser/analyze.h"
33#include "parser/parsetree.h"
34#include "rewrite/rewriteHandler.h"
35#include "storage/bufmgr.h"
36#include "tcop/tcopprot.h"
37#include "utils/builtins.h"
38#include "utils/guc_tables.h"
39#include "utils/json.h"
40#include "utils/lsyscache.h"
41#include "utils/rel.h"
42#include "utils/ruleutils.h"
43#include "utils/snapmgr.h"
44#include "utils/tuplesort.h"
45#include "utils/typcache.h"
46#include "utils/xml.h"
47
48
49/* Hook for plugins to get control in ExplainOneQuery() */
50ExplainOneQuery_hook_type ExplainOneQuery_hook = NULL;
51
52/* Hook for plugins to get control in explain_get_index_name() */
53explain_get_index_name_hook_type explain_get_index_name_hook = NULL;
54
55/* per-plan and per-node hooks for plugins to print additional info */
56explain_per_plan_hook_type explain_per_plan_hook = NULL;
57explain_per_node_hook_type explain_per_node_hook = NULL;
58
59/*
60 * Various places within need to convert bytes to kilobytes. Round these up
61 * to the next whole kilobyte.
62 */
63#define BYTES_TO_KILOBYTES(b) (((b) + 1023) / 1024)
64
65static void ExplainOneQuery(Query *query, int cursorOptions,
66 IntoClause *into, ExplainState *es,
67 ParseState *pstate, ParamListInfo params);
68static void ExplainPrintJIT(ExplainState *es, int jit_flags,
69 JitInstrumentation *ji);
70static void ExplainPrintSerialize(ExplainState *es,
71 SerializeMetrics *metrics);
72static void report_triggers(ResultRelInfo *rInfo, bool show_relname,
73 ExplainState *es);
74static double elapsed_time(instr_time *starttime);
75static bool ExplainPreScanNode(PlanState *planstate, Bitmapset **rels_used);
76static void ExplainNode(PlanState *planstate, List *ancestors,
77 const char *relationship, const char *plan_name,
78 ExplainState *es);
79static void show_plan_tlist(PlanState *planstate, List *ancestors,
80 ExplainState *es);
81static void show_expression(Node *node, const char *qlabel,
82 PlanState *planstate, List *ancestors,
83 bool useprefix, ExplainState *es);
84static void show_qual(List *qual, const char *qlabel,
85 PlanState *planstate, List *ancestors,
86 bool useprefix, ExplainState *es);
87static void show_scan_qual(List *qual, const char *qlabel,
88 PlanState *planstate, List *ancestors,
89 ExplainState *es);
90static void show_upper_qual(List *qual, const char *qlabel,
91 PlanState *planstate, List *ancestors,
92 ExplainState *es);
93static void show_sort_keys(SortState *sortstate, List *ancestors,
94 ExplainState *es);
95static void show_incremental_sort_keys(IncrementalSortState *incrsortstate,
96 List *ancestors, ExplainState *es);
97static void show_merge_append_keys(MergeAppendState *mstate, List *ancestors,
98 ExplainState *es);
99static void show_agg_keys(AggState *astate, List *ancestors,
100 ExplainState *es);
101static void show_grouping_sets(PlanState *planstate, Agg *agg,
102 List *ancestors, ExplainState *es);
103static void show_grouping_set_keys(PlanState *planstate,
104 Agg *aggnode, Sort *sortnode,
105 List *context, bool useprefix,
106 List *ancestors, ExplainState *es);
107static void show_group_keys(GroupState *gstate, List *ancestors,
108 ExplainState *es);
109static void show_sort_group_keys(PlanState *planstate, const char *qlabel,
110 int nkeys, int nPresortedKeys, AttrNumber *keycols,
111 Oid *sortOperators, Oid *collations, bool *nullsFirst,
112 List *ancestors, ExplainState *es);
113static void show_sortorder_options(StringInfo buf, Node *sortexpr,
114 Oid sortOperator, Oid collation, bool nullsFirst);
115static void show_window_def(WindowAggState *planstate,
116 List *ancestors, ExplainState *es);
117static void show_window_keys(StringInfo buf, PlanState *planstate,
118 int nkeys, AttrNumber *keycols,
119 List *ancestors, ExplainState *es);
120static void show_storage_info(char *maxStorageType, int64 maxSpaceUsed,
121 ExplainState *es);
122static void show_tablesample(TableSampleClause *tsc, PlanState *planstate,
123 List *ancestors, ExplainState *es);
124static void show_sort_info(SortState *sortstate, ExplainState *es);
125static void show_incremental_sort_info(IncrementalSortState *incrsortstate,
126 ExplainState *es);
127static void show_hash_info(HashState *hashstate, ExplainState *es);
128static void show_material_info(MaterialState *mstate, ExplainState *es);
129static void show_windowagg_info(WindowAggState *winstate, ExplainState *es);
130static void show_ctescan_info(CteScanState *ctescanstate, ExplainState *es);
131static void show_table_func_scan_info(TableFuncScanState *tscanstate,
132 ExplainState *es);
133static void show_recursive_union_info(RecursiveUnionState *rstate,
134 ExplainState *es);
135static void show_memoize_info(MemoizeState *mstate, List *ancestors,
136 ExplainState *es);
137static void show_hashagg_info(AggState *aggstate, ExplainState *es);
138static void show_indexsearches_info(PlanState *planstate, ExplainState *es);
139static void show_tidbitmap_info(BitmapHeapScanState *planstate,
140 ExplainState *es);
141static void show_instrumentation_count(const char *qlabel, int which,
142 PlanState *planstate, ExplainState *es);
143static void show_foreignscan_info(ForeignScanState *fsstate, ExplainState *es);
144static const char *explain_get_index_name(Oid indexId);
145static bool peek_buffer_usage(ExplainState *es, const BufferUsage *usage);
146static void show_buffer_usage(ExplainState *es, const BufferUsage *usage);
147static void show_wal_usage(ExplainState *es, const WalUsage *usage);
148static void show_memory_counters(ExplainState *es,
149 const MemoryContextCounters *mem_counters);
150static void show_result_replacement_info(Result *result, ExplainState *es);
151static void ExplainIndexScanDetails(Oid indexid, ScanDirection indexorderdir,
152 ExplainState *es);
153static void ExplainScanTarget(Scan *plan, ExplainState *es);
154static void ExplainModifyTarget(ModifyTable *plan, ExplainState *es);
155static void ExplainTargetRel(Plan *plan, Index rti, ExplainState *es);
156static void show_modifytable_info(ModifyTableState *mtstate, List *ancestors,
157 ExplainState *es);
158static void ExplainMemberNodes(PlanState **planstates, int nplans,
159 List *ancestors, ExplainState *es);
160static void ExplainMissingMembers(int nplans, int nchildren, ExplainState *es);
161static void ExplainSubPlans(List *plans, List *ancestors,
162 const char *relationship, ExplainState *es);
163static void ExplainCustomChildren(CustomScanState *css,
164 List *ancestors, ExplainState *es);
165static ExplainWorkersState *ExplainCreateWorkersState(int num_workers);
166static void ExplainOpenWorker(int n, ExplainState *es);
167static void ExplainCloseWorker(int n, ExplainState *es);
168static void ExplainFlushWorkersState(ExplainState *es);
169
170
171
172/*
173 * ExplainQuery -
174 * execute an EXPLAIN command
175 */
176void
177ExplainQuery(ParseState *pstate, ExplainStmt *stmt,
178 ParamListInfo params, DestReceiver *dest)
179{
180 ExplainState *es = NewExplainState();
181 TupOutputState *tstate;
182 JumbleState *jstate = NULL;
183 Query *query;
184 List *rewritten;
185
186 /* Configure the ExplainState based on the provided options */
187 ParseExplainOptionList(es, stmt->options, pstate);
188
189 /* Extract the query and, if enabled, jumble it */
190 query = castNode(Query, stmt->query);
191 if (IsQueryIdEnabled())
192 jstate = JumbleQuery(query);
193
194 if (post_parse_analyze_hook)
195 (*post_parse_analyze_hook) (pstate, query, jstate);
196
197 /*
198 * Parse analysis was done already, but we still have to run the rule
199 * rewriter. We do not do AcquireRewriteLocks: we assume the query either
200 * came straight from the parser, or suitable locks were acquired by
201 * plancache.c.
202 */
203 rewritten = QueryRewrite(castNode(Query, stmt->query));
204
205 /* emit opening boilerplate */
206 ExplainBeginOutput(es);
207
208 if (rewritten == NIL)
209 {
210 /*
211 * In the case of an INSTEAD NOTHING, tell at least that. But in
212 * non-text format, the output is delimited, so this isn't necessary.
213 */
214 if (es->format == EXPLAIN_FORMAT_TEXT)
215 appendStringInfoString(es->str, "Query rewrites to nothing\n");
216 }
217 else
218 {
219 ListCell *l;
220
221 /* Explain every plan */
222 foreach(l, rewritten)
223 {
224 ExplainOneQuery(lfirst_node(Query, l),
225 CURSOR_OPT_PARALLEL_OK, NULL, es,
226 pstate, params);
227
228 /* Separate plans with an appropriate separator */
229 if (lnext(rewritten, l) != NULL)
230 ExplainSeparatePlans(es);
231 }
232 }
233
234 /* emit closing boilerplate */
235 ExplainEndOutput(es);
236 Assert(es->indent == 0);
237
238 /* output tuples */
239 tstate = begin_tup_output_tupdesc(dest, ExplainResultDesc(stmt),
240 &TTSOpsVirtual);
241 if (es->format == EXPLAIN_FORMAT_TEXT)
242 do_text_output_multiline(tstate, es->str->data);
243 else
244 do_text_output_oneline(tstate, es->str->data);
245 end_tup_output(tstate);
246
247 pfree(es->str->data);
248}
249
250/*
251 * ExplainResultDesc -
252 * construct the result tupledesc for an EXPLAIN
253 */
254TupleDesc
255ExplainResultDesc(ExplainStmt *stmt)
256{
257 TupleDesc tupdesc;
258 ListCell *lc;
259 Oid result_type = TEXTOID;
260
261 /* Check for XML format option */
262 foreach(lc, stmt->options)
263 {
264 DefElem *opt = (DefElem *) lfirst(lc);
265
266 if (strcmp(opt->defname, "format") == 0)
267 {
268 char *p = defGetString(opt);
269
270 if (strcmp(p, "xml") == 0)
271 result_type = XMLOID;
272 else if (strcmp(p, "json") == 0)
273 result_type = JSONOID;
274 else
275 result_type = TEXTOID;
276 /* don't "break", as ExplainQuery will use the last value */
277 }
278 }
279
280 /* Need a tuple descriptor representing a single TEXT or XML column */
281 tupdesc = CreateTemplateTupleDesc(1);
282 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "QUERY PLAN",
283 result_type, -1, 0);
284 return tupdesc;
285}
286
287/*
288 * ExplainOneQuery -
289 * print out the execution plan for one Query
290 *
291 * "into" is NULL unless we are explaining the contents of a CreateTableAsStmt.
292 */
293static void
294ExplainOneQuery(Query *query, int cursorOptions,
295 IntoClause *into, ExplainState *es,
296 ParseState *pstate, ParamListInfo params)
297{
298 /* planner will not cope with utility statements */
299 if (query->commandType == CMD_UTILITY)
300 {
301 ExplainOneUtility(query->utilityStmt, into, es, pstate, params);
302 return;
303 }
304
305 /* if an advisor plugin is present, let it manage things */
306 if (ExplainOneQuery_hook)
307 (*ExplainOneQuery_hook) (query, cursorOptions, into, es,
308 pstate->p_sourcetext, params, pstate->p_queryEnv);
309 else
310 standard_ExplainOneQuery(query, cursorOptions, into, es,
311 pstate->p_sourcetext, params, pstate->p_queryEnv);
312}
313
314/*
315 * standard_ExplainOneQuery -
316 * print out the execution plan for one Query, without calling a hook.
317 */
318void
319standard_ExplainOneQuery(Query *query, int cursorOptions,
320 IntoClause *into, ExplainState *es,
321 const char *queryString, ParamListInfo params,
322 QueryEnvironment *queryEnv)
323{
324 PlannedStmt *plan;
325 instr_time planstart,
326 planduration;
327 BufferUsage bufusage_start,
328 bufusage;
329 MemoryContextCounters mem_counters;
330 MemoryContext planner_ctx = NULL;
331 MemoryContext saved_ctx = NULL;
332
333 if (es->memory)
334 {
335 /*
336 * Create a new memory context to measure planner's memory consumption
337 * accurately. Note that if the planner were to be modified to use a
338 * different memory context type, here we would be changing that to
339 * AllocSet, which might be undesirable. However, we don't have a way
340 * to create a context of the same type as another, so we pray and
341 * hope that this is OK.
342 */
343 planner_ctx = AllocSetContextCreate(CurrentMemoryContext,
344 "explain analyze planner context",
345 ALLOCSET_DEFAULT_SIZES);
346 saved_ctx = MemoryContextSwitchTo(planner_ctx);
347 }
348
349 if (es->buffers)
350 bufusage_start = pgBufferUsage;
351 INSTR_TIME_SET_CURRENT(planstart);
352
353 /* plan the query */
354 plan = pg_plan_query(query, queryString, cursorOptions, params, es);
355
356 INSTR_TIME_SET_CURRENT(planduration);
357 INSTR_TIME_SUBTRACT(planduration, planstart);
358
359 if (es->memory)
360 {
361 MemoryContextSwitchTo(saved_ctx);
362 MemoryContextMemConsumed(planner_ctx, &mem_counters);
363 }
364
365 /* calc differences of buffer counters. */
366 if (es->buffers)
367 {
368 memset(&bufusage, 0, sizeof(BufferUsage));
369 BufferUsageAccumDiff(&bufusage, &pgBufferUsage, &bufusage_start);
370 }
371
372 /* run it (if needed) and produce output */
373 ExplainOnePlan(plan, into, es, queryString, params, queryEnv,
374 &planduration, (es->buffers ? &bufusage : NULL),
375 es->memory ? &mem_counters : NULL);
376}
377
378/*
379 * ExplainOneUtility -
380 * print out the execution plan for one utility statement
381 * (In general, utility statements don't have plans, but there are some
382 * we treat as special cases)
383 *
384 * "into" is NULL unless we are explaining the contents of a CreateTableAsStmt.
385 *
386 * This is exported because it's called back from prepare.c in the
387 * EXPLAIN EXECUTE case. In that case, we'll be dealing with a statement
388 * that's in the plan cache, so we have to ensure we don't modify it.
389 */
390void
391ExplainOneUtility(Node *utilityStmt, IntoClause *into, ExplainState *es,
392 ParseState *pstate, ParamListInfo params)
393{
394 if (utilityStmt == NULL)
395 return;
396
397 if (IsA(utilityStmt, CreateTableAsStmt))
398 {
399 /*
400 * We have to rewrite the contained SELECT and then pass it back to
401 * ExplainOneQuery. Copy to be safe in the EXPLAIN EXECUTE case.
402 */
403 CreateTableAsStmt *ctas = (CreateTableAsStmt *) utilityStmt;
404 Query *ctas_query;
405 List *rewritten;
406 JumbleState *jstate = NULL;
407
408 /*
409 * Check if the relation exists or not. This is done at this stage to
410 * avoid query planning or execution.
411 */
412 if (CreateTableAsRelExists(ctas))
413 {
414 if (ctas->objtype == OBJECT_TABLE)
415 ExplainDummyGroup("CREATE TABLE AS", NULL, es);
416 else if (ctas->objtype == OBJECT_MATVIEW)
417 ExplainDummyGroup("CREATE MATERIALIZED VIEW", NULL, es);
418 else
419 elog(ERROR, "unexpected object type: %d",
420 (int) ctas->objtype);
421 return;
422 }
423
424 ctas_query = castNode(Query, copyObject(ctas->query));
425 if (IsQueryIdEnabled())
426 jstate = JumbleQuery(ctas_query);
427 if (post_parse_analyze_hook)
428 (*post_parse_analyze_hook) (pstate, ctas_query, jstate);
429 rewritten = QueryRewrite(ctas_query);
430 Assert(list_length(rewritten) == 1);
431 ExplainOneQuery(linitial_node(Query, rewritten),
432 CURSOR_OPT_PARALLEL_OK, ctas->into, es,
433 pstate, params);
434 }
435 else if (IsA(utilityStmt, DeclareCursorStmt))
436 {
437 /*
438 * Likewise for DECLARE CURSOR.
439 *
440 * Notice that if you say EXPLAIN ANALYZE DECLARE CURSOR then we'll
441 * actually run the query. This is different from pre-8.3 behavior
442 * but seems more useful than not running the query. No cursor will
443 * be created, however.
444 */
445 DeclareCursorStmt *dcs = (DeclareCursorStmt *) utilityStmt;
446 Query *dcs_query;
447 List *rewritten;
448 JumbleState *jstate = NULL;
449
450 dcs_query = castNode(Query, copyObject(dcs->query));
451 if (IsQueryIdEnabled())
452 jstate = JumbleQuery(dcs_query);
453 if (post_parse_analyze_hook)
454 (*post_parse_analyze_hook) (pstate, dcs_query, jstate);
455
456 rewritten = QueryRewrite(dcs_query);
457 Assert(list_length(rewritten) == 1);
458 ExplainOneQuery(linitial_node(Query, rewritten),
459 dcs->options, NULL, es,
460 pstate, params);
461 }
462 else if (IsA(utilityStmt, ExecuteStmt))
463 ExplainExecuteQuery((ExecuteStmt *) utilityStmt, into, es,
464 pstate, params);
465 else if (IsA(utilityStmt, NotifyStmt))
466 {
467 if (es->format == EXPLAIN_FORMAT_TEXT)
468 appendStringInfoString(es->str, "NOTIFY\n");
469 else
470 ExplainDummyGroup("Notify", NULL, es);
471 }
472 else
473 {
474 if (es->format == EXPLAIN_FORMAT_TEXT)
475 appendStringInfoString(es->str,
476 "Utility statements have no plan structure\n");
477 else
478 ExplainDummyGroup("Utility Statement", NULL, es);
479 }
480}
481
482/*
483 * ExplainOnePlan -
484 * given a planned query, execute it if needed, and then print
485 * EXPLAIN output
486 *
487 * "into" is NULL unless we are explaining the contents of a CreateTableAsStmt,
488 * in which case executing the query should result in creating that table.
489 *
490 * This is exported because it's called back from prepare.c in the
491 * EXPLAIN EXECUTE case, and because an index advisor plugin would need
492 * to call it.
493 */
494void
495ExplainOnePlan(PlannedStmt *plannedstmt, IntoClause *into, ExplainState *es,
496 const char *queryString, ParamListInfo params,
497 QueryEnvironment *queryEnv, const instr_time *planduration,
498 const BufferUsage *bufusage,
499 const MemoryContextCounters *mem_counters)
500{
501 DestReceiver *dest;
502 QueryDesc *queryDesc;
503 instr_time starttime;
504 double totaltime = 0;
505 int eflags;
506 int instrument_option = 0;
507 SerializeMetrics serializeMetrics = {0};
508
509 Assert(plannedstmt->commandType != CMD_UTILITY);
510
511 if (es->analyze && es->timing)
512 instrument_option |= INSTRUMENT_TIMER;
513 else if (es->analyze)
514 instrument_option |= INSTRUMENT_ROWS;
515
516 if (es->buffers)
517 instrument_option |= INSTRUMENT_BUFFERS;
518 if (es->wal)
519 instrument_option |= INSTRUMENT_WAL;
520
521 /*
522 * We always collect timing for the entire statement, even when node-level
523 * timing is off, so we don't look at es->timing here. (We could skip
524 * this if !es->summary, but it's hardly worth the complication.)
525 */
526 INSTR_TIME_SET_CURRENT(starttime);
527
528 /*
529 * Use a snapshot with an updated command ID to ensure this query sees
530 * results of any previously executed queries.
531 */
532 PushCopiedSnapshot(GetActiveSnapshot());
533 UpdateActiveSnapshotCommandId();
534
535 /*
536 * We discard the output if we have no use for it. If we're explaining
537 * CREATE TABLE AS, we'd better use the appropriate tuple receiver, while
538 * the SERIALIZE option requires its own tuple receiver. (If you specify
539 * SERIALIZE while explaining CREATE TABLE AS, you'll see zeroes for the
540 * results, which is appropriate since no data would have gone to the
541 * client.)
542 */
543 if (into)
544 dest = CreateIntoRelDestReceiver(into);
545 else if (es->serialize != EXPLAIN_SERIALIZE_NONE)
546 dest = CreateExplainSerializeDestReceiver(es);
547 else
548 dest = None_Receiver;
549
550 /* Create a QueryDesc for the query */
551 queryDesc = CreateQueryDesc(plannedstmt, queryString,
552 GetActiveSnapshot(), InvalidSnapshot,
553 dest, params, queryEnv, instrument_option);
554
555 /* Select execution options */
556 if (es->analyze)
557 eflags = 0; /* default run-to-completion flags */
558 else
559 eflags = EXEC_FLAG_EXPLAIN_ONLY;
560 if (es->generic)
561 eflags |= EXEC_FLAG_EXPLAIN_GENERIC;
562 if (into)
563 eflags |= GetIntoRelEFlags(into);
564
565 /* call ExecutorStart to prepare the plan for execution */
566 ExecutorStart(queryDesc, eflags);
567
568 /* Execute the plan for statistics if asked for */
569 if (es->analyze)
570 {
571 ScanDirection dir;
572
573 /* EXPLAIN ANALYZE CREATE TABLE AS WITH NO DATA is weird */
574 if (into && into->skipData)
575 dir = NoMovementScanDirection;
576 else
577 dir = ForwardScanDirection;
578
579 /* run the plan */
580 ExecutorRun(queryDesc, dir, 0);
581
582 /* run cleanup too */
583 ExecutorFinish(queryDesc);
584
585 /* We can't run ExecutorEnd 'till we're done printing the stats... */
586 totaltime += elapsed_time(&starttime);
587 }
588
589 /* grab serialization metrics before we destroy the DestReceiver */
590 if (es->serialize != EXPLAIN_SERIALIZE_NONE)
591 serializeMetrics = GetSerializationMetrics(dest);
592
593 /* call the DestReceiver's destroy method even during explain */
594 dest->rDestroy(dest);
595
596 ExplainOpenGroup("Query", NULL, true, es);
597
598 /* Create textual dump of plan tree */
599 ExplainPrintPlan(es, queryDesc);
600
601 /* Show buffer and/or memory usage in planning */
602 if (peek_buffer_usage(es, bufusage) || mem_counters)
603 {
604 ExplainOpenGroup("Planning", "Planning", true, es);
605
606 if (es->format == EXPLAIN_FORMAT_TEXT)
607 {
608 ExplainIndentText(es);
609 appendStringInfoString(es->str, "Planning:\n");
610 es->indent++;
611 }
612
613 if (bufusage)
614 show_buffer_usage(es, bufusage);
615
616 if (mem_counters)
617 show_memory_counters(es, mem_counters);
618
619 if (es->format == EXPLAIN_FORMAT_TEXT)
620 es->indent--;
621
622 ExplainCloseGroup("Planning", "Planning", true, es);
623 }
624
625 if (es->summary && planduration)
626 {
627 double plantime = INSTR_TIME_GET_DOUBLE(*planduration);
628
629 ExplainPropertyFloat("Planning Time", "ms", 1000.0 * plantime, 3, es);
630 }
631
632 /* Print info about runtime of triggers */
633 if (es->analyze)
634 ExplainPrintTriggers(es, queryDesc);
635
636 /*
637 * Print info about JITing. Tied to es->costs because we don't want to
638 * display this in regression tests, as it'd cause output differences
639 * depending on build options. Might want to separate that out from COSTS
640 * at a later stage.
641 */
642 if (es->costs)
643 ExplainPrintJITSummary(es, queryDesc);
644
645 /* Print info about serialization of output */
646 if (es->serialize != EXPLAIN_SERIALIZE_NONE)
647 ExplainPrintSerialize(es, &serializeMetrics);
648
649 /* Allow plugins to print additional information */
650 if (explain_per_plan_hook)
651 (*explain_per_plan_hook) (plannedstmt, into, es, queryString,
652 params, queryEnv);
653
654 /*
655 * Close down the query and free resources. Include time for this in the
656 * total execution time (although it should be pretty minimal).
657 */
658 INSTR_TIME_SET_CURRENT(starttime);
659
660 ExecutorEnd(queryDesc);
661
662 FreeQueryDesc(queryDesc);
663
664 PopActiveSnapshot();
665
666 /* We need a CCI just in case query expanded to multiple plans */
667 if (es->analyze)
668 CommandCounterIncrement();
669
670 totaltime += elapsed_time(&starttime);
671
672 /*
673 * We only report execution time if we actually ran the query (that is,
674 * the user specified ANALYZE), and if summary reporting is enabled (the
675 * user can set SUMMARY OFF to not have the timing information included in
676 * the output). By default, ANALYZE sets SUMMARY to true.
677 */
678 if (es->summary && es->analyze)
679 ExplainPropertyFloat("Execution Time", "ms", 1000.0 * totaltime, 3,
680 es);
681
682 ExplainCloseGroup("Query", NULL, true, es);
683}
684
685/*
686 * ExplainPrintSettings -
687 * Print summary of modified settings affecting query planning.
688 */
689static void
690ExplainPrintSettings(ExplainState *es)
691{
692 int num;
693 struct config_generic **gucs;
694
695 /* bail out if information about settings not requested */
696 if (!es->settings)
697 return;
698
699 /* request an array of relevant settings */
700 gucs = get_explain_guc_options(&num);
701
702 if (es->format != EXPLAIN_FORMAT_TEXT)
703 {
704 ExplainOpenGroup("Settings", "Settings", true, es);
705
706 for (int i = 0; i < num; i++)
707 {
708 char *setting;
709 struct config_generic *conf = gucs[i];
710
711 setting = GetConfigOptionByName(conf->name, NULL, true);
712
713 ExplainPropertyText(conf->name, setting, es);
714 }
715
716 ExplainCloseGroup("Settings", "Settings", true, es);
717 }
718 else
719 {
720 StringInfoData str;
721
722 /* In TEXT mode, print nothing if there are no options */
723 if (num <= 0)
724 return;
725
726 initStringInfo(&str);
727
728 for (int i = 0; i < num; i++)
729 {
730 char *setting;
731 struct config_generic *conf = gucs[i];
732
733 if (i > 0)
734 appendStringInfoString(&str, ", ");
735
736 setting = GetConfigOptionByName(conf->name, NULL, true);
737
738 if (setting)
739 appendStringInfo(&str, "%s = '%s'", conf->name, setting);
740 else
741 appendStringInfo(&str, "%s = NULL", conf->name);
742 }
743
744 ExplainPropertyText("Settings", str.data, es);
745 }
746}
747
748/*
749 * ExplainPrintPlan -
750 * convert a QueryDesc's plan tree to text and append it to es->str
751 *
752 * The caller should have set up the options fields of *es, as well as
753 * initializing the output buffer es->str. Also, output formatting state
754 * such as the indent level is assumed valid. Plan-tree-specific fields
755 * in *es are initialized here.
756 *
757 * NB: will not work on utility statements
758 */
759void
760ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc)
761{
762 Bitmapset *rels_used = NULL;
763 PlanState *ps;
764 ListCell *lc;
765
766 /* Set up ExplainState fields associated with this plan tree */
767 Assert(queryDesc->plannedstmt != NULL);
768 es->pstmt = queryDesc->plannedstmt;
769 es->rtable = queryDesc->plannedstmt->rtable;
770 ExplainPreScanNode(queryDesc->planstate, &rels_used);
771 es->rtable_names = select_rtable_names_for_explain(es->rtable, rels_used);
772 es->deparse_cxt = deparse_context_for_plan_tree(queryDesc->plannedstmt,
773 es->rtable_names);
774 es->printed_subplans = NULL;
775 es->rtable_size = list_length(es->rtable);
776 foreach(lc, es->rtable)
777 {
778 RangeTblEntry *rte = lfirst_node(RangeTblEntry, lc);
779
780 if (rte->rtekind == RTE_GROUP)
781 {
782 es->rtable_size--;
783 break;
784 }
785 }
786
787 /*
788 * Sometimes we mark a Gather node as "invisible", which means that it's
789 * not to be displayed in EXPLAIN output. The purpose of this is to allow
790 * running regression tests with debug_parallel_query=regress to get the
791 * same results as running the same tests with debug_parallel_query=off.
792 * Such marking is currently only supported on a Gather at the top of the
793 * plan. We skip that node, and we must also hide per-worker detail data
794 * further down in the plan tree.
795 */
796 ps = queryDesc->planstate;
797 if (IsA(ps, GatherState) && ((Gather *) ps->plan)->invisible)
798 {
799 ps = outerPlanState(ps);
800 es->hide_workers = true;
801 }
802 ExplainNode(ps, NIL, NULL, NULL, es);
803
804 /*
805 * If requested, include information about GUC parameters with values that
806 * don't match the built-in defaults.
807 */
808 ExplainPrintSettings(es);
809
810 /*
811 * COMPUTE_QUERY_ID_REGRESS means COMPUTE_QUERY_ID_AUTO, but we don't show
812 * the queryid in any of the EXPLAIN plans to keep stable the results
813 * generated by regression test suites.
814 */
815 if (es->verbose && queryDesc->plannedstmt->queryId != INT64CONST(0) &&
816 compute_query_id != COMPUTE_QUERY_ID_REGRESS)
817 {
818 ExplainPropertyInteger("Query Identifier", NULL,
819 queryDesc->plannedstmt->queryId, es);
820 }
821}
822
823/*
824 * ExplainPrintTriggers -
825 * convert a QueryDesc's trigger statistics to text and append it to
826 * es->str
827 *
828 * The caller should have set up the options fields of *es, as well as
829 * initializing the output buffer es->str. Other fields in *es are
830 * initialized here.
831 */
832void
833ExplainPrintTriggers(ExplainState *es, QueryDesc *queryDesc)
834{
835 ResultRelInfo *rInfo;
836 bool show_relname;
837 List *resultrels;
838 List *routerels;
839 List *targrels;
840 ListCell *l;
841
842 resultrels = queryDesc->estate->es_opened_result_relations;
843 routerels = queryDesc->estate->es_tuple_routing_result_relations;
844 targrels = queryDesc->estate->es_trig_target_relations;
845
846 ExplainOpenGroup("Triggers", "Triggers", false, es);
847
848 show_relname = (list_length(resultrels) > 1 ||
849 routerels != NIL || targrels != NIL);
850 foreach(l, resultrels)
851 {
852 rInfo = (ResultRelInfo *) lfirst(l);
853 report_triggers(rInfo, show_relname, es);
854 }
855
856 foreach(l, routerels)
857 {
858 rInfo = (ResultRelInfo *) lfirst(l);
859 report_triggers(rInfo, show_relname, es);
860 }
861
862 foreach(l, targrels)
863 {
864 rInfo = (ResultRelInfo *) lfirst(l);
865 report_triggers(rInfo, show_relname, es);
866 }
867
868 ExplainCloseGroup("Triggers", "Triggers", false, es);
869}
870
871/*
872 * ExplainPrintJITSummary -
873 * Print summarized JIT instrumentation from leader and workers
874 */
875void
876ExplainPrintJITSummary(ExplainState *es, QueryDesc *queryDesc)
877{
878 JitInstrumentation ji = {0};
879
880 if (!(queryDesc->estate->es_jit_flags & PGJIT_PERFORM))
881 return;
882
883 /*
884 * Work with a copy instead of modifying the leader state, since this
885 * function may be called twice
886 */
887 if (queryDesc->estate->es_jit)
888 InstrJitAgg(&ji, &queryDesc->estate->es_jit->instr);
889
890 /* If this process has done JIT in parallel workers, merge stats */
891 if (queryDesc->estate->es_jit_worker_instr)
892 InstrJitAgg(&ji, queryDesc->estate->es_jit_worker_instr);
893
894 ExplainPrintJIT(es, queryDesc->estate->es_jit_flags, &ji);
895}
896
897/*
898 * ExplainPrintJIT -
899 * Append information about JITing to es->str.
900 */
901static void
902ExplainPrintJIT(ExplainState *es, int jit_flags, JitInstrumentation *ji)
903{
904 instr_time total_time;
905
906 /* don't print information if no JITing happened */
907 if (!ji || ji->created_functions == 0)
908 return;
909
910 /* calculate total time */
911 INSTR_TIME_SET_ZERO(total_time);
912 /* don't add deform_counter, it's included in generation_counter */
913 INSTR_TIME_ADD(total_time, ji->generation_counter);
914 INSTR_TIME_ADD(total_time, ji->inlining_counter);
915 INSTR_TIME_ADD(total_time, ji->optimization_counter);
916 INSTR_TIME_ADD(total_time, ji->emission_counter);
917
918 ExplainOpenGroup("JIT", "JIT", true, es);
919
920 /* for higher density, open code the text output format */
921 if (es->format == EXPLAIN_FORMAT_TEXT)
922 {
923 ExplainIndentText(es);
924 appendStringInfoString(es->str, "JIT:\n");
925 es->indent++;
926
927 ExplainPropertyInteger("Functions", NULL, ji->created_functions, es);
928
929 ExplainIndentText(es);
930 appendStringInfo(es->str, "Options: %s %s, %s %s, %s %s, %s %s\n",
931 "Inlining", jit_flags & PGJIT_INLINE ? "true" : "false",
932 "Optimization", jit_flags & PGJIT_OPT3 ? "true" : "false",
933 "Expressions", jit_flags & PGJIT_EXPR ? "true" : "false",
934 "Deforming", jit_flags & PGJIT_DEFORM ? "true" : "false");
935
936 if (es->analyze && es->timing)
937 {
938 ExplainIndentText(es);
939 appendStringInfo(es->str,
940 "Timing: %s %.3f ms (%s %.3f ms), %s %.3f ms, %s %.3f ms, %s %.3f ms, %s %.3f ms\n",
941 "Generation", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->generation_counter),
942 "Deform", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->deform_counter),
943 "Inlining", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->inlining_counter),
944 "Optimization", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->optimization_counter),
945 "Emission", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->emission_counter),
946 "Total", 1000.0 * INSTR_TIME_GET_DOUBLE(total_time));
947 }
948
949 es->indent--;
950 }
951 else
952 {
953 ExplainPropertyInteger("Functions", NULL, ji->created_functions, es);
954
955 ExplainOpenGroup("Options", "Options", true, es);
956 ExplainPropertyBool("Inlining", jit_flags & PGJIT_INLINE, es);
957 ExplainPropertyBool("Optimization", jit_flags & PGJIT_OPT3, es);
958 ExplainPropertyBool("Expressions", jit_flags & PGJIT_EXPR, es);
959 ExplainPropertyBool("Deforming", jit_flags & PGJIT_DEFORM, es);
960 ExplainCloseGroup("Options", "Options", true, es);
961
962 if (es->analyze && es->timing)
963 {
964 ExplainOpenGroup("Timing", "Timing", true, es);
965
966 ExplainOpenGroup("Generation", "Generation", true, es);
967 ExplainPropertyFloat("Deform", "ms",
968 1000.0 * INSTR_TIME_GET_DOUBLE(ji->deform_counter),
969 3, es);
970 ExplainPropertyFloat("Total", "ms",
971 1000.0 * INSTR_TIME_GET_DOUBLE(ji->generation_counter),
972 3, es);
973 ExplainCloseGroup("Generation", "Generation", true, es);
974
975 ExplainPropertyFloat("Inlining", "ms",
976 1000.0 * INSTR_TIME_GET_DOUBLE(ji->inlining_counter),
977 3, es);
978 ExplainPropertyFloat("Optimization", "ms",
979 1000.0 * INSTR_TIME_GET_DOUBLE(ji->optimization_counter),
980 3, es);
981 ExplainPropertyFloat("Emission", "ms",
982 1000.0 * INSTR_TIME_GET_DOUBLE(ji->emission_counter),
983 3, es);
984 ExplainPropertyFloat("Total", "ms",
985 1000.0 * INSTR_TIME_GET_DOUBLE(total_time),
986 3, es);
987
988 ExplainCloseGroup("Timing", "Timing", true, es);
989 }
990 }
991
992 ExplainCloseGroup("JIT", "JIT", true, es);
993}
994
995/*
996 * ExplainPrintSerialize -
997 * Append information about query output volume to es->str.
998 */
999static void
1000ExplainPrintSerialize(ExplainState *es, SerializeMetrics *metrics)
1001{
1002 const char *format;
1003
1004 /* We shouldn't get called for EXPLAIN_SERIALIZE_NONE */
1005 if (es->serialize == EXPLAIN_SERIALIZE_TEXT)
1006 format = "text";
1007 else
1008 {
1009 Assert(es->serialize == EXPLAIN_SERIALIZE_BINARY);
1010 format = "binary";
1011 }
1012
1013 ExplainOpenGroup("Serialization", "Serialization", true, es);
1014
1015 if (es->format == EXPLAIN_FORMAT_TEXT)
1016 {
1017 ExplainIndentText(es);
1018 if (es->timing)
1019 appendStringInfo(es->str, "Serialization: time=%.3f ms output=" UINT64_FORMAT "kB format=%s\n",
1020 1000.0 * INSTR_TIME_GET_DOUBLE(metrics->timeSpent),
1021 BYTES_TO_KILOBYTES(metrics->bytesSent),
1022 format);
1023 else
1024 appendStringInfo(es->str, "Serialization: output=" UINT64_FORMAT "kB format=%s\n",
1025 BYTES_TO_KILOBYTES(metrics->bytesSent),
1026 format);
1027
1028 if (es->buffers && peek_buffer_usage(es, &metrics->bufferUsage))
1029 {
1030 es->indent++;
1031 show_buffer_usage(es, &metrics->bufferUsage);
1032 es->indent--;
1033 }
1034 }
1035 else
1036 {
1037 if (es->timing)
1038 ExplainPropertyFloat("Time", "ms",
1039 1000.0 * INSTR_TIME_GET_DOUBLE(metrics->timeSpent),
1040 3, es);
1041 ExplainPropertyUInteger("Output Volume", "kB",
1042 BYTES_TO_KILOBYTES(metrics->bytesSent), es);
1043 ExplainPropertyText("Format", format, es);
1044 if (es->buffers)
1045 show_buffer_usage(es, &metrics->bufferUsage);
1046 }
1047
1048 ExplainCloseGroup("Serialization", "Serialization", true, es);
1049}
1050
1051/*
1052 * ExplainQueryText -
1053 * add a "Query Text" node that contains the actual text of the query
1054 *
1055 * The caller should have set up the options fields of *es, as well as
1056 * initializing the output buffer es->str.
1057 *
1058 */
1059void
1060ExplainQueryText(ExplainState *es, QueryDesc *queryDesc)
1061{
1062 if (queryDesc->sourceText)
1063 ExplainPropertyText("Query Text", queryDesc->sourceText, es);
1064}
1065
1066/*
1067 * ExplainQueryParameters -
1068 * add a "Query Parameters" node that describes the parameters of the query
1069 *
1070 * The caller should have set up the options fields of *es, as well as
1071 * initializing the output buffer es->str.
1072 *
1073 */
1074void
1075ExplainQueryParameters(ExplainState *es, ParamListInfo params, int maxlen)
1076{
1077 char *str;
1078
1079 /* This check is consistent with errdetail_params() */
1080 if (params == NULL || params->numParams <= 0 || maxlen == 0)
1081 return;
1082
1083 str = BuildParamLogString(params, NULL, maxlen);
1084 if (str && str[0] != '\0')
1085 ExplainPropertyText("Query Parameters", str, es);
1086}
1087
1088/*
1089 * report_triggers -
1090 * report execution stats for a single relation's triggers
1091 */
1092static void
1093report_triggers(ResultRelInfo *rInfo, bool show_relname, ExplainState *es)
1094{
1095 int nt;
1096
1097 if (!rInfo->ri_TrigDesc || !rInfo->ri_TrigInstrument)
1098 return;
1099 for (nt = 0; nt < rInfo->ri_TrigDesc->numtriggers; nt++)
1100 {
1101 Trigger *trig = rInfo->ri_TrigDesc->triggers + nt;
1102 Instrumentation *instr = rInfo->ri_TrigInstrument + nt;
1103 char *relname;
1104 char *conname = NULL;
1105
1106 /* Must clean up instrumentation state */
1107 InstrEndLoop(instr);
1108
1109 /*
1110 * We ignore triggers that were never invoked; they likely aren't
1111 * relevant to the current query type.
1112 */
1113 if (instr->ntuples == 0)
1114 continue;
1115
1116 ExplainOpenGroup("Trigger", NULL, true, es);
1117
1118 relname = RelationGetRelationName(rInfo->ri_RelationDesc);
1119 if (OidIsValid(trig->tgconstraint))
1120 conname = get_constraint_name(trig->tgconstraint);
1121
1122 /*
1123 * In text format, we avoid printing both the trigger name and the
1124 * constraint name unless VERBOSE is specified. In non-text formats
1125 * we just print everything.
1126 */
1127 if (es->format == EXPLAIN_FORMAT_TEXT)
1128 {
1129 if (es->verbose || conname == NULL)
1130 appendStringInfo(es->str, "Trigger %s", trig->tgname);
1131 else
1132 appendStringInfoString(es->str, "Trigger");
1133 if (conname)
1134 appendStringInfo(es->str, " for constraint %s", conname);
1135 if (show_relname)
1136 appendStringInfo(es->str, " on %s", relname);
1137 if (es->timing)
1138 appendStringInfo(es->str, ": time=%.3f calls=%.0f\n",
1139 INSTR_TIME_GET_MILLISEC(instr->total),
1140 instr->ntuples);
1141 else
1142 appendStringInfo(es->str, ": calls=%.0f\n", instr->ntuples);
1143 }
1144 else
1145 {
1146 ExplainPropertyText("Trigger Name", trig->tgname, es);
1147 if (conname)
1148 ExplainPropertyText("Constraint Name", conname, es);
1149 ExplainPropertyText("Relation", relname, es);
1150 if (es->timing)
1151 ExplainPropertyFloat("Time", "ms",
1152 INSTR_TIME_GET_MILLISEC(instr->total), 3,
1153 es);
1154 ExplainPropertyFloat("Calls", NULL, instr->ntuples, 0, es);
1155 }
1156
1157 if (conname)
1158 pfree(conname);
1159
1160 ExplainCloseGroup("Trigger", NULL, true, es);
1161 }
1162}
1163
1164/* Compute elapsed time in seconds since given timestamp */
1165static double
1166elapsed_time(instr_time *starttime)
1167{
1168 instr_time endtime;
1169
1170 INSTR_TIME_SET_CURRENT(endtime);
1171 INSTR_TIME_SUBTRACT(endtime, *starttime);
1172 return INSTR_TIME_GET_DOUBLE(endtime);
1173}
1174
1175/*
1176 * ExplainPreScanNode -
1177 * Prescan the planstate tree to identify which RTEs are referenced
1178 *
1179 * Adds the relid of each referenced RTE to *rels_used. The result controls
1180 * which RTEs are assigned aliases by select_rtable_names_for_explain.
1181 * This ensures that we don't confusingly assign un-suffixed aliases to RTEs
1182 * that never appear in the EXPLAIN output (such as inheritance parents).
1183 */
1184static bool
1185ExplainPreScanNode(PlanState *planstate, Bitmapset **rels_used)
1186{
1187 Plan *plan = planstate->plan;
1188
1189 switch (nodeTag(plan))
1190 {
1191 case T_SeqScan:
1192 case T_SampleScan:
1193 case T_IndexScan:
1194 case T_IndexOnlyScan:
1195 case T_BitmapHeapScan:
1196 case T_TidScan:
1197 case T_TidRangeScan:
1198 case T_SubqueryScan:
1199 case T_FunctionScan:
1200 case T_TableFuncScan:
1201 case T_ValuesScan:
1202 case T_CteScan:
1203 case T_NamedTuplestoreScan:
1204 case T_WorkTableScan:
1205 *rels_used = bms_add_member(*rels_used,
1206 ((Scan *) plan)->scanrelid);
1207 break;
1208 case T_ForeignScan:
1209 *rels_used = bms_add_members(*rels_used,
1210 ((ForeignScan *) plan)->fs_base_relids);
1211 break;
1212 case T_CustomScan:
1213 *rels_used = bms_add_members(*rels_used,
1214 ((CustomScan *) plan)->custom_relids);
1215 break;
1216 case T_ModifyTable:
1217 *rels_used = bms_add_member(*rels_used,
1218 ((ModifyTable *) plan)->nominalRelation);
1219 if (((ModifyTable *) plan)->exclRelRTI)
1220 *rels_used = bms_add_member(*rels_used,
1221 ((ModifyTable *) plan)->exclRelRTI);
1222 /* Ensure Vars used in RETURNING will have refnames */
1223 if (plan->targetlist)
1224 *rels_used = bms_add_member(*rels_used,
1225 linitial_int(((ModifyTable *) plan)->resultRelations));
1226 break;
1227 case T_Append:
1228 *rels_used = bms_add_members(*rels_used,
1229 ((Append *) plan)->apprelids);
1230 break;
1231 case T_MergeAppend:
1232 *rels_used = bms_add_members(*rels_used,
1233 ((MergeAppend *) plan)->apprelids);
1234 break;
1235 case T_Result:
1236 *rels_used = bms_add_members(*rels_used,
1237 ((Result *) plan)->relids);
1238 break;
1239 default:
1240 break;
1241 }
1242
1243 return planstate_tree_walker(planstate, ExplainPreScanNode, rels_used);
1244}
1245
1246/*
1247 * plan_is_disabled
1248 * Checks if the given plan node type was disabled during query planning.
1249 * This is evident by the disabled_nodes field being higher than the sum of
1250 * the disabled_nodes field from the plan's children.
1251 */
1252static bool
1253plan_is_disabled(Plan *plan)
1254{
1255 int child_disabled_nodes;
1256
1257 /* The node is certainly not disabled if this is zero */
1258 if (plan->disabled_nodes == 0)
1259 return false;
1260
1261 child_disabled_nodes = 0;
1262
1263 /*
1264 * Handle special nodes first. Children of BitmapOrs and BitmapAnds can't
1265 * be disabled, so no need to handle those specifically.
1266 */
1267 if (IsA(plan, Append))
1268 {
1269 ListCell *lc;
1270 Append *aplan = (Append *) plan;
1271
1272 /*
1273 * Sum the Append childrens' disabled_nodes. This purposefully
1274 * includes any run-time pruned children. Ignoring those could give
1275 * us the incorrect number of disabled nodes.
1276 */
1277 foreach(lc, aplan->appendplans)
1278 {
1279 Plan *subplan = lfirst(lc);
1280
1281 child_disabled_nodes += subplan->disabled_nodes;
1282 }
1283 }
1284 else if (IsA(plan, MergeAppend))
1285 {
1286 ListCell *lc;
1287 MergeAppend *maplan = (MergeAppend *) plan;
1288
1289 /*
1290 * Sum the MergeAppend childrens' disabled_nodes. This purposefully
1291 * includes any run-time pruned children. Ignoring those could give
1292 * us the incorrect number of disabled nodes.
1293 */
1294 foreach(lc, maplan->mergeplans)
1295 {
1296 Plan *subplan = lfirst(lc);
1297
1298 child_disabled_nodes += subplan->disabled_nodes;
1299 }
1300 }
1301 else if (IsA(plan, SubqueryScan))
1302 child_disabled_nodes += ((SubqueryScan *) plan)->subplan->disabled_nodes;
1303 else if (IsA(plan, CustomScan))
1304 {
1305 ListCell *lc;
1306 CustomScan *cplan = (CustomScan *) plan;
1307
1308 foreach(lc, cplan->custom_plans)
1309 {
1310 Plan *subplan = lfirst(lc);
1311
1312 child_disabled_nodes += subplan->disabled_nodes;
1313 }
1314 }
1315 else
1316 {
1317 /*
1318 * Else, sum up disabled_nodes from the plan's inner and outer side.
1319 */
1320 if (outerPlan(plan))
1321 child_disabled_nodes += outerPlan(plan)->disabled_nodes;
1322 if (innerPlan(plan))
1323 child_disabled_nodes += innerPlan(plan)->disabled_nodes;
1324 }
1325
1326 /*
1327 * It's disabled if the plan's disabled_nodes is higher than the sum of
1328 * its child's plan disabled_nodes.
1329 */
1330 if (plan->disabled_nodes > child_disabled_nodes)
1331 return true;
1332
1333 return false;
1334}
1335
1336/*
1337 * ExplainNode -
1338 * Appends a description of a plan tree to es->str
1339 *
1340 * planstate points to the executor state node for the current plan node.
1341 * We need to work from a PlanState node, not just a Plan node, in order to
1342 * get at the instrumentation data (if any) as well as the list of subplans.
1343 *
1344 * ancestors is a list of parent Plan and SubPlan nodes, most-closely-nested
1345 * first. These are needed in order to interpret PARAM_EXEC Params.
1346 *
1347 * relationship describes the relationship of this plan node to its parent
1348 * (eg, "Outer", "Inner"); it can be null at top level. plan_name is an
1349 * optional name to be attached to the node.
1350 *
1351 * In text format, es->indent is controlled in this function since we only
1352 * want it to change at plan-node boundaries (but a few subroutines will
1353 * transiently increment it). In non-text formats, es->indent corresponds
1354 * to the nesting depth of logical output groups, and therefore is controlled
1355 * by ExplainOpenGroup/ExplainCloseGroup.
1356 */
1357static void
1358ExplainNode(PlanState *planstate, List *ancestors,
1359 const char *relationship, const char *plan_name,
1360 ExplainState *es)
1361{
1362 Plan *plan = planstate->plan;
1363 const char *pname; /* node type name for text output */
1364 const char *sname; /* node type name for non-text output */
1365 const char *strategy = NULL;
1366 const char *partialmode = NULL;
1367 const char *operation = NULL;
1368 const char *custom_name = NULL;
1369 ExplainWorkersState *save_workers_state = es->workers_state;
1370 int save_indent = es->indent;
1371 bool haschildren;
1372 bool isdisabled;
1373
1374 /*
1375 * Prepare per-worker output buffers, if needed. We'll append the data in
1376 * these to the main output string further down.
1377 */
1378 if (planstate->worker_instrument && es->analyze && !es->hide_workers)
1379 es->workers_state = ExplainCreateWorkersState(planstate->worker_instrument->num_workers);
1380 else
1381 es->workers_state = NULL;
1382
1383 /* Identify plan node type, and print generic details */
1384 switch (nodeTag(plan))
1385 {
1386 case T_Result:
1387 pname = sname = "Result";
1388 break;
1389 case T_ProjectSet:
1390 pname = sname = "ProjectSet";
1391 break;
1392 case T_ModifyTable:
1393 sname = "ModifyTable";
1394 switch (((ModifyTable *) plan)->operation)
1395 {
1396 case CMD_INSERT:
1397 pname = operation = "Insert";
1398 break;
1399 case CMD_UPDATE:
1400 pname = operation = "Update";
1401 break;
1402 case CMD_DELETE:
1403 pname = operation = "Delete";
1404 break;
1405 case CMD_MERGE:
1406 pname = operation = "Merge";
1407 break;
1408 default:
1409 pname = "???";
1410 break;
1411 }
1412 break;
1413 case T_Append:
1414 pname = sname = "Append";
1415 break;
1416 case T_MergeAppend:
1417 pname = sname = "Merge Append";
1418 break;
1419 case T_RecursiveUnion:
1420 pname = sname = "Recursive Union";
1421 break;
1422 case T_BitmapAnd:
1423 pname = sname = "BitmapAnd";
1424 break;
1425 case T_BitmapOr:
1426 pname = sname = "BitmapOr";
1427 break;
1428 case T_NestLoop:
1429 pname = sname = "Nested Loop";
1430 break;
1431 case T_MergeJoin:
1432 pname = "Merge"; /* "Join" gets added by jointype switch */
1433 sname = "Merge Join";
1434 break;
1435 case T_HashJoin:
1436 pname = "Hash"; /* "Join" gets added by jointype switch */
1437 sname = "Hash Join";
1438 break;
1439 case T_SeqScan:
1440 pname = sname = "Seq Scan";
1441 break;
1442 case T_SampleScan:
1443 pname = sname = "Sample Scan";
1444 break;
1445 case T_Gather:
1446 pname = sname = "Gather";
1447 break;
1448 case T_GatherMerge:
1449 pname = sname = "Gather Merge";
1450 break;
1451 case T_IndexScan:
1452 pname = sname = "Index Scan";
1453 break;
1454 case T_IndexOnlyScan:
1455 pname = sname = "Index Only Scan";
1456 break;
1457 case T_BitmapIndexScan:
1458 pname = sname = "Bitmap Index Scan";
1459 break;
1460 case T_BitmapHeapScan:
1461 pname = sname = "Bitmap Heap Scan";
1462 break;
1463 case T_TidScan:
1464 pname = sname = "Tid Scan";
1465 break;
1466 case T_TidRangeScan:
1467 pname = sname = "Tid Range Scan";
1468 break;
1469 case T_SubqueryScan:
1470 pname = sname = "Subquery Scan";
1471 break;
1472 case T_FunctionScan:
1473 pname = sname = "Function Scan";
1474 break;
1475 case T_TableFuncScan:
1476 pname = sname = "Table Function Scan";
1477 break;
1478 case T_ValuesScan:
1479 pname = sname = "Values Scan";
1480 break;
1481 case T_CteScan:
1482 pname = sname = "CTE Scan";
1483 break;
1484 case T_NamedTuplestoreScan:
1485 pname = sname = "Named Tuplestore Scan";
1486 break;
1487 case T_WorkTableScan:
1488 pname = sname = "WorkTable Scan";
1489 break;
1490 case T_ForeignScan:
1491 sname = "Foreign Scan";
1492 switch (((ForeignScan *) plan)->operation)
1493 {
1494 case CMD_SELECT:
1495 pname = "Foreign Scan";
1496 operation = "Select";
1497 break;
1498 case CMD_INSERT:
1499 pname = "Foreign Insert";
1500 operation = "Insert";
1501 break;
1502 case CMD_UPDATE:
1503 pname = "Foreign Update";
1504 operation = "Update";
1505 break;
1506 case CMD_DELETE:
1507 pname = "Foreign Delete";
1508 operation = "Delete";
1509 break;
1510 default:
1511 pname = "???";
1512 break;
1513 }
1514 break;
1515 case T_CustomScan:
1516 sname = "Custom Scan";
1517 custom_name = ((CustomScan *) plan)->methods->CustomName;
1518 if (custom_name)
1519 pname = psprintf("Custom Scan (%s)", custom_name);
1520 else
1521 pname = sname;
1522 break;
1523 case T_Material:
1524 pname = sname = "Materialize";
1525 break;
1526 case T_Memoize:
1527 pname = sname = "Memoize";
1528 break;
1529 case T_Sort:
1530 pname = sname = "Sort";
1531 break;
1532 case T_IncrementalSort:
1533 pname = sname = "Incremental Sort";
1534 break;
1535 case T_Group:
1536 pname = sname = "Group";
1537 break;
1538 case T_Agg:
1539 {
1540 Agg *agg = (Agg *) plan;
1541
1542 sname = "Aggregate";
1543 switch (agg->aggstrategy)
1544 {
1545 case AGG_PLAIN:
1546 pname = "Aggregate";
1547 strategy = "Plain";
1548 break;
1549 case AGG_SORTED:
1550 pname = "GroupAggregate";
1551 strategy = "Sorted";
1552 break;
1553 case AGG_HASHED:
1554 pname = "HashAggregate";
1555 strategy = "Hashed";
1556 break;
1557 case AGG_MIXED:
1558 pname = "MixedAggregate";
1559 strategy = "Mixed";
1560 break;
1561 default:
1562 pname = "Aggregate ???";
1563 strategy = "???";
1564 break;
1565 }
1566
1567 if (DO_AGGSPLIT_SKIPFINAL(agg->aggsplit))
1568 {
1569 partialmode = "Partial";
1570 pname = psprintf("%s %s", partialmode, pname);
1571 }
1572 else if (DO_AGGSPLIT_COMBINE(agg->aggsplit))
1573 {
1574 partialmode = "Finalize";
1575 pname = psprintf("%s %s", partialmode, pname);
1576 }
1577 else
1578 partialmode = "Simple";
1579 }
1580 break;
1581 case T_WindowAgg:
1582 pname = sname = "WindowAgg";
1583 break;
1584 case T_Unique:
1585 pname = sname = "Unique";
1586 break;
1587 case T_SetOp:
1588 sname = "SetOp";
1589 switch (((SetOp *) plan)->strategy)
1590 {
1591 case SETOP_SORTED:
1592 pname = "SetOp";
1593 strategy = "Sorted";
1594 break;
1595 case SETOP_HASHED:
1596 pname = "HashSetOp";
1597 strategy = "Hashed";
1598 break;
1599 default:
1600 pname = "SetOp ???";
1601 strategy = "???";
1602 break;
1603 }
1604 break;
1605 case T_LockRows:
1606 pname = sname = "LockRows";
1607 break;
1608 case T_Limit:
1609 pname = sname = "Limit";
1610 break;
1611 case T_Hash:
1612 pname = sname = "Hash";
1613 break;
1614 default:
1615 pname = sname = "???";
1616 break;
1617 }
1618
1619 ExplainOpenGroup("Plan",
1620 relationship ? NULL : "Plan",
1621 true, es);
1622
1623 if (es->format == EXPLAIN_FORMAT_TEXT)
1624 {
1625 if (plan_name)
1626 {
1627 ExplainIndentText(es);
1628 appendStringInfo(es->str, "%s\n", plan_name);
1629 es->indent++;
1630 }
1631 if (es->indent)
1632 {
1633 ExplainIndentText(es);
1634 appendStringInfoString(es->str, "-> ");
1635 es->indent += 2;
1636 }
1637 if (plan->parallel_aware)
1638 appendStringInfoString(es->str, "Parallel ");
1639 if (plan->async_capable)
1640 appendStringInfoString(es->str, "Async ");
1641 appendStringInfoString(es->str, pname);
1642 es->indent++;
1643 }
1644 else
1645 {
1646 ExplainPropertyText("Node Type", sname, es);
1647 if (strategy)
1648 ExplainPropertyText("Strategy", strategy, es);
1649 if (partialmode)
1650 ExplainPropertyText("Partial Mode", partialmode, es);
1651 if (operation)
1652 ExplainPropertyText("Operation", operation, es);
1653 if (relationship)
1654 ExplainPropertyText("Parent Relationship", relationship, es);
1655 if (plan_name)
1656 ExplainPropertyText("Subplan Name", plan_name, es);
1657 if (custom_name)
1658 ExplainPropertyText("Custom Plan Provider", custom_name, es);
1659 ExplainPropertyBool("Parallel Aware", plan->parallel_aware, es);
1660 ExplainPropertyBool("Async Capable", plan->async_capable, es);
1661 }
1662
1663 switch (nodeTag(plan))
1664 {
1665 case T_SeqScan:
1666 case T_SampleScan:
1667 case T_BitmapHeapScan:
1668 case T_TidScan:
1669 case T_TidRangeScan:
1670 case T_SubqueryScan:
1671 case T_FunctionScan:
1672 case T_TableFuncScan:
1673 case T_ValuesScan:
1674 case T_CteScan:
1675 case T_WorkTableScan:
1676 ExplainScanTarget((Scan *) plan, es);
1677 break;
1678 case T_ForeignScan:
1679 case T_CustomScan:
1680 if (((Scan *) plan)->scanrelid > 0)
1681 ExplainScanTarget((Scan *) plan, es);
1682 break;
1683 case T_IndexScan:
1684 {
1685 IndexScan *indexscan = (IndexScan *) plan;
1686
1687 ExplainIndexScanDetails(indexscan->indexid,
1688 indexscan->indexorderdir,
1689 es);
1690 ExplainScanTarget((Scan *) indexscan, es);
1691 }
1692 break;
1693 case T_IndexOnlyScan:
1694 {
1695 IndexOnlyScan *indexonlyscan = (IndexOnlyScan *) plan;
1696
1697 ExplainIndexScanDetails(indexonlyscan->indexid,
1698 indexonlyscan->indexorderdir,
1699 es);
1700 ExplainScanTarget((Scan *) indexonlyscan, es);
1701 }
1702 break;
1703 case T_BitmapIndexScan:
1704 {
1705 BitmapIndexScan *bitmapindexscan = (BitmapIndexScan *) plan;
1706 const char *indexname =
1707 explain_get_index_name(bitmapindexscan->indexid);
1708
1709 if (es->format == EXPLAIN_FORMAT_TEXT)
1710 appendStringInfo(es->str, " on %s",
1711 quote_identifier(indexname));
1712 else
1713 ExplainPropertyText("Index Name", indexname, es);
1714 }
1715 break;
1716 case T_ModifyTable:
1717 ExplainModifyTarget((ModifyTable *) plan, es);
1718 break;
1719 case T_NestLoop:
1720 case T_MergeJoin:
1721 case T_HashJoin:
1722 {
1723 const char *jointype;
1724
1725 switch (((Join *) plan)->jointype)
1726 {
1727 case JOIN_INNER:
1728 jointype = "Inner";
1729 break;
1730 case JOIN_LEFT:
1731 jointype = "Left";
1732 break;
1733 case JOIN_FULL:
1734 jointype = "Full";
1735 break;
1736 case JOIN_RIGHT:
1737 jointype = "Right";
1738 break;
1739 case JOIN_SEMI:
1740 jointype = "Semi";
1741 break;
1742 case JOIN_ANTI:
1743 jointype = "Anti";
1744 break;
1745 case JOIN_RIGHT_SEMI:
1746 jointype = "Right Semi";
1747 break;
1748 case JOIN_RIGHT_ANTI:
1749 jointype = "Right Anti";
1750 break;
1751 default:
1752 jointype = "???";
1753 break;
1754 }
1755 if (es->format == EXPLAIN_FORMAT_TEXT)
1756 {
1757 /*
1758 * For historical reasons, the join type is interpolated
1759 * into the node type name...
1760 */
1761 if (((Join *) plan)->jointype != JOIN_INNER)
1762 appendStringInfo(es->str, " %s Join", jointype);
1763 else if (!IsA(plan, NestLoop))
1764 appendStringInfoString(es->str, " Join");
1765 }
1766 else
1767 ExplainPropertyText("Join Type", jointype, es);
1768 }
1769 break;
1770 case T_SetOp:
1771 {
1772 const char *setopcmd;
1773
1774 switch (((SetOp *) plan)->cmd)
1775 {
1776 case SETOPCMD_INTERSECT:
1777 setopcmd = "Intersect";
1778 break;
1779 case SETOPCMD_INTERSECT_ALL:
1780 setopcmd = "Intersect All";
1781 break;
1782 case SETOPCMD_EXCEPT:
1783 setopcmd = "Except";
1784 break;
1785 case SETOPCMD_EXCEPT_ALL:
1786 setopcmd = "Except All";
1787 break;
1788 default:
1789 setopcmd = "???";
1790 break;
1791 }
1792 if (es->format == EXPLAIN_FORMAT_TEXT)
1793 appendStringInfo(es->str, " %s", setopcmd);
1794 else
1795 ExplainPropertyText("Command", setopcmd, es);
1796 }
1797 break;
1798 default:
1799 break;
1800 }
1801
1802 if (es->costs)
1803 {
1804 if (es->format == EXPLAIN_FORMAT_TEXT)
1805 {
1806 appendStringInfo(es->str, " (cost=%.2f..%.2f rows=%.0f width=%d)",
1807 plan->startup_cost, plan->total_cost,
1808 plan->plan_rows, plan->plan_width);
1809 }
1810 else
1811 {
1812 ExplainPropertyFloat("Startup Cost", NULL, plan->startup_cost,
1813 2, es);
1814 ExplainPropertyFloat("Total Cost", NULL, plan->total_cost,
1815 2, es);
1816 ExplainPropertyFloat("Plan Rows", NULL, plan->plan_rows,
1817 0, es);
1818 ExplainPropertyInteger("Plan Width", NULL, plan->plan_width,
1819 es);
1820 }
1821 }
1822
1823 /*
1824 * We have to forcibly clean up the instrumentation state because we
1825 * haven't done ExecutorEnd yet. This is pretty grotty ...
1826 *
1827 * Note: contrib/auto_explain could cause instrumentation to be set up
1828 * even though we didn't ask for it here. Be careful not to print any
1829 * instrumentation results the user didn't ask for. But we do the
1830 * InstrEndLoop call anyway, if possible, to reduce the number of cases
1831 * auto_explain has to contend with.
1832 */
1833 if (planstate->instrument)
1834 InstrEndLoop(planstate->instrument);
1835
1836 if (es->analyze &&
1837 planstate->instrument && planstate->instrument->nloops > 0)
1838 {
1839 double nloops = planstate->instrument->nloops;
1840 double startup_ms = INSTR_TIME_GET_MILLISEC(planstate->instrument->startup) / nloops;
1841 double total_ms = INSTR_TIME_GET_MILLISEC(planstate->instrument->total) / nloops;
1842 double rows = planstate->instrument->ntuples / nloops;
1843
1844 if (es->format == EXPLAIN_FORMAT_TEXT)
1845 {
1846 appendStringInfoString(es->str, " (actual ");
1847
1848 if (es->timing)
1849 appendStringInfo(es->str, "time=%.3f..%.3f ", startup_ms, total_ms);
1850
1851 appendStringInfo(es->str, "rows=%.2f loops=%.0f)", rows, nloops);
1852 }
1853 else
1854 {
1855 if (es->timing)
1856 {
1857 ExplainPropertyFloat("Actual Startup Time", "ms", startup_ms,
1858 3, es);
1859 ExplainPropertyFloat("Actual Total Time", "ms", total_ms,
1860 3, es);
1861 }
1862 ExplainPropertyFloat("Actual Rows", NULL, rows, 2, es);
1863 ExplainPropertyFloat("Actual Loops", NULL, nloops, 0, es);
1864 }
1865 }
1866 else if (es->analyze)
1867 {
1868 if (es->format == EXPLAIN_FORMAT_TEXT)
1869 appendStringInfoString(es->str, " (never executed)");
1870 else
1871 {
1872 if (es->timing)
1873 {
1874 ExplainPropertyFloat("Actual Startup Time", "ms", 0.0, 3, es);
1875 ExplainPropertyFloat("Actual Total Time", "ms", 0.0, 3, es);
1876 }
1877 ExplainPropertyFloat("Actual Rows", NULL, 0.0, 0, es);
1878 ExplainPropertyFloat("Actual Loops", NULL, 0.0, 0, es);
1879 }
1880 }
1881
1882 /* in text format, first line ends here */
1883 if (es->format == EXPLAIN_FORMAT_TEXT)
1884 appendStringInfoChar(es->str, '\n');
1885
1886
1887 isdisabled = plan_is_disabled(plan);
1888 if (es->format != EXPLAIN_FORMAT_TEXT || isdisabled)
1889 ExplainPropertyBool("Disabled", isdisabled, es);
1890
1891 /* prepare per-worker general execution details */
1892 if (es->workers_state && es->verbose)
1893 {
1894 WorkerInstrumentation *w = planstate->worker_instrument;
1895
1896 for (int n = 0; n < w->num_workers; n++)
1897 {
1898 Instrumentation *instrument = &w->instrument[n];
1899 double nloops = instrument->nloops;
1900 double startup_ms;
1901 double total_ms;
1902 double rows;
1903
1904 if (nloops <= 0)
1905 continue;
1906 startup_ms = INSTR_TIME_GET_MILLISEC(instrument->startup) / nloops;
1907 total_ms = INSTR_TIME_GET_MILLISEC(instrument->total) / nloops;
1908 rows = instrument->ntuples / nloops;
1909
1910 ExplainOpenWorker(n, es);
1911
1912 if (es->format == EXPLAIN_FORMAT_TEXT)
1913 {
1914 ExplainIndentText(es);
1915 appendStringInfoString(es->str, "actual ");
1916 if (es->timing)
1917 appendStringInfo(es->str, "time=%.3f..%.3f ", startup_ms, total_ms);
1918
1919 appendStringInfo(es->str, "rows=%.2f loops=%.0f\n", rows, nloops);
1920 }
1921 else
1922 {
1923 if (es->timing)
1924 {
1925 ExplainPropertyFloat("Actual Startup Time", "ms",
1926 startup_ms, 3, es);
1927 ExplainPropertyFloat("Actual Total Time", "ms",
1928 total_ms, 3, es);
1929 }
1930
1931 ExplainPropertyFloat("Actual Rows", NULL, rows, 2, es);
1932 ExplainPropertyFloat("Actual Loops", NULL, nloops, 0, es);
1933 }
1934
1935 ExplainCloseWorker(n, es);
1936 }
1937 }
1938
1939 /* target list */
1940 if (es->verbose)
1941 show_plan_tlist(planstate, ancestors, es);
1942
1943 /* unique join */
1944 switch (nodeTag(plan))
1945 {
1946 case T_NestLoop:
1947 case T_MergeJoin:
1948 case T_HashJoin:
1949 /* try not to be too chatty about this in text mode */
1950 if (es->format != EXPLAIN_FORMAT_TEXT ||
1951 (es->verbose && ((Join *) plan)->inner_unique))
1952 ExplainPropertyBool("Inner Unique",
1953 ((Join *) plan)->inner_unique,
1954 es);
1955 break;
1956 default:
1957 break;
1958 }
1959
1960 /* quals, sort keys, etc */
1961 switch (nodeTag(plan))
1962 {
1963 case T_IndexScan:
1964 show_scan_qual(((IndexScan *) plan)->indexqualorig,
1965 "Index Cond", planstate, ancestors, es);
1966 if (((IndexScan *) plan)->indexqualorig)
1967 show_instrumentation_count("Rows Removed by Index Recheck", 2,
1968 planstate, es);
1969 show_scan_qual(((IndexScan *) plan)->indexorderbyorig,
1970 "Order By", planstate, ancestors, es);
1971 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
1972 if (plan->qual)
1973 show_instrumentation_count("Rows Removed by Filter", 1,
1974 planstate, es);
1975 show_indexsearches_info(planstate, es);
1976 break;
1977 case T_IndexOnlyScan:
1978 show_scan_qual(((IndexOnlyScan *) plan)->indexqual,
1979 "Index Cond", planstate, ancestors, es);
1980 if (((IndexOnlyScan *) plan)->recheckqual)
1981 show_instrumentation_count("Rows Removed by Index Recheck", 2,
1982 planstate, es);
1983 show_scan_qual(((IndexOnlyScan *) plan)->indexorderby,
1984 "Order By", planstate, ancestors, es);
1985 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
1986 if (plan->qual)
1987 show_instrumentation_count("Rows Removed by Filter", 1,
1988 planstate, es);
1989 if (es->analyze)
1990 ExplainPropertyFloat("Heap Fetches", NULL,
1991 planstate->instrument->ntuples2, 0, es);
1992 show_indexsearches_info(planstate, es);
1993 break;
1994 case T_BitmapIndexScan:
1995 show_scan_qual(((BitmapIndexScan *) plan)->indexqualorig,
1996 "Index Cond", planstate, ancestors, es);
1997 show_indexsearches_info(planstate, es);
1998 break;
1999 case T_BitmapHeapScan:
2000 show_scan_qual(((BitmapHeapScan *) plan)->bitmapqualorig,
2001 "Recheck Cond", planstate, ancestors, es);
2002 if (((BitmapHeapScan *) plan)->bitmapqualorig)
2003 show_instrumentation_count("Rows Removed by Index Recheck", 2,
2004 planstate, es);
2005 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2006 if (plan->qual)
2007 show_instrumentation_count("Rows Removed by Filter", 1,
2008 planstate, es);
2009 show_tidbitmap_info((BitmapHeapScanState *) planstate, es);
2010 break;
2011 case T_SampleScan:
2012 show_tablesample(((SampleScan *) plan)->tablesample,
2013 planstate, ancestors, es);
2014 /* fall through to print additional fields the same as SeqScan */
2015 /* FALLTHROUGH */
2016 case T_SeqScan:
2017 case T_ValuesScan:
2018 case T_CteScan:
2019 case T_NamedTuplestoreScan:
2020 case T_WorkTableScan:
2021 case T_SubqueryScan:
2022 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2023 if (plan->qual)
2024 show_instrumentation_count("Rows Removed by Filter", 1,
2025 planstate, es);
2026 if (IsA(plan, CteScan))
2027 show_ctescan_info(castNode(CteScanState, planstate), es);
2028 break;
2029 case T_Gather:
2030 {
2031 Gather *gather = (Gather *) plan;
2032
2033 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2034 if (plan->qual)
2035 show_instrumentation_count("Rows Removed by Filter", 1,
2036 planstate, es);
2037 ExplainPropertyInteger("Workers Planned", NULL,
2038 gather->num_workers, es);
2039
2040 if (es->analyze)
2041 {
2042 int nworkers;
2043
2044 nworkers = ((GatherState *) planstate)->nworkers_launched;
2045 ExplainPropertyInteger("Workers Launched", NULL,
2046 nworkers, es);
2047 }
2048
2049 if (gather->single_copy || es->format != EXPLAIN_FORMAT_TEXT)
2050 ExplainPropertyBool("Single Copy", gather->single_copy, es);
2051 }
2052 break;
2053 case T_GatherMerge:
2054 {
2055 GatherMerge *gm = (GatherMerge *) plan;
2056
2057 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2058 if (plan->qual)
2059 show_instrumentation_count("Rows Removed by Filter", 1,
2060 planstate, es);
2061 ExplainPropertyInteger("Workers Planned", NULL,
2062 gm->num_workers, es);
2063
2064 if (es->analyze)
2065 {
2066 int nworkers;
2067
2068 nworkers = ((GatherMergeState *) planstate)->nworkers_launched;
2069 ExplainPropertyInteger("Workers Launched", NULL,
2070 nworkers, es);
2071 }
2072 }
2073 break;
2074 case T_FunctionScan:
2075 if (es->verbose)
2076 {
2077 List *fexprs = NIL;
2078 ListCell *lc;
2079
2080 foreach(lc, ((FunctionScan *) plan)->functions)
2081 {
2082 RangeTblFunction *rtfunc = (RangeTblFunction *) lfirst(lc);
2083
2084 fexprs = lappend(fexprs, rtfunc->funcexpr);
2085 }
2086 /* We rely on show_expression to insert commas as needed */
2087 show_expression((Node *) fexprs,
2088 "Function Call", planstate, ancestors,
2089 es->verbose, es);
2090 }
2091 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2092 if (plan->qual)
2093 show_instrumentation_count("Rows Removed by Filter", 1,
2094 planstate, es);
2095 break;
2096 case T_TableFuncScan:
2097 if (es->verbose)
2098 {
2099 TableFunc *tablefunc = ((TableFuncScan *) plan)->tablefunc;
2100
2101 show_expression((Node *) tablefunc,
2102 "Table Function Call", planstate, ancestors,
2103 es->verbose, es);
2104 }
2105 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2106 if (plan->qual)
2107 show_instrumentation_count("Rows Removed by Filter", 1,
2108 planstate, es);
2109 show_table_func_scan_info(castNode(TableFuncScanState,
2110 planstate), es);
2111 break;
2112 case T_TidScan:
2113 {
2114 /*
2115 * The tidquals list has OR semantics, so be sure to show it
2116 * as an OR condition.
2117 */
2118 List *tidquals = ((TidScan *) plan)->tidquals;
2119
2120 if (list_length(tidquals) > 1)
2121 tidquals = list_make1(make_orclause(tidquals));
2122 show_scan_qual(tidquals, "TID Cond", planstate, ancestors, es);
2123 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2124 if (plan->qual)
2125 show_instrumentation_count("Rows Removed by Filter", 1,
2126 planstate, es);
2127 }
2128 break;
2129 case T_TidRangeScan:
2130 {
2131 /*
2132 * The tidrangequals list has AND semantics, so be sure to
2133 * show it as an AND condition.
2134 */
2135 List *tidquals = ((TidRangeScan *) plan)->tidrangequals;
2136
2137 if (list_length(tidquals) > 1)
2138 tidquals = list_make1(make_andclause(tidquals));
2139 show_scan_qual(tidquals, "TID Cond", planstate, ancestors, es);
2140 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2141 if (plan->qual)
2142 show_instrumentation_count("Rows Removed by Filter", 1,
2143 planstate, es);
2144 }
2145 break;
2146 case T_ForeignScan:
2147 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2148 if (plan->qual)
2149 show_instrumentation_count("Rows Removed by Filter", 1,
2150 planstate, es);
2151 show_foreignscan_info((ForeignScanState *) planstate, es);
2152 break;
2153 case T_CustomScan:
2154 {
2155 CustomScanState *css = (CustomScanState *) planstate;
2156
2157 show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
2158 if (plan->qual)
2159 show_instrumentation_count("Rows Removed by Filter", 1,
2160 planstate, es);
2161 if (css->methods->ExplainCustomScan)
2162 css->methods->ExplainCustomScan(css, ancestors, es);
2163 }
2164 break;
2165 case T_NestLoop:
2166 show_upper_qual(((NestLoop *) plan)->join.joinqual,
2167 "Join Filter", planstate, ancestors, es);
2168 if (((NestLoop *) plan)->join.joinqual)
2169 show_instrumentation_count("Rows Removed by Join Filter", 1,
2170 planstate, es);
2171 show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
2172 if (plan->qual)
2173 show_instrumentation_count("Rows Removed by Filter", 2,
2174 planstate, es);
2175 break;
2176 case T_MergeJoin:
2177 show_upper_qual(((MergeJoin *) plan)->mergeclauses,
2178 "Merge Cond", planstate, ancestors, es);
2179 show_upper_qual(((MergeJoin *) plan)->join.joinqual,
2180 "Join Filter", planstate, ancestors, es);
2181 if (((MergeJoin *) plan)->join.joinqual)
2182 show_instrumentation_count("Rows Removed by Join Filter", 1,
2183 planstate, es);
2184 show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
2185 if (plan->qual)
2186 show_instrumentation_count("Rows Removed by Filter", 2,
2187 planstate, es);
2188 break;
2189 case T_HashJoin:
2190 show_upper_qual(((HashJoin *) plan)->hashclauses,
2191 "Hash Cond", planstate, ancestors, es);
2192 show_upper_qual(((HashJoin *) plan)->join.joinqual,
2193 "Join Filter", planstate, ancestors, es);
2194 if (((HashJoin *) plan)->join.joinqual)
2195 show_instrumentation_count("Rows Removed by Join Filter", 1,
2196 planstate, es);
2197 show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
2198 if (plan->qual)
2199 show_instrumentation_count("Rows Removed by Filter", 2,
2200 planstate, es);
2201 break;
2202 case T_Agg:
2203 show_agg_keys(castNode(AggState, planstate), ancestors, es);
2204 show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
2205 show_hashagg_info((AggState *) planstate, es);
2206 if (plan->qual)
2207 show_instrumentation_count("Rows Removed by Filter", 1,
2208 planstate, es);
2209 break;
2210 case T_WindowAgg:
2211 show_window_def(castNode(WindowAggState, planstate), ancestors, es);
2212 show_upper_qual(((WindowAgg *) plan)->runConditionOrig,
2213 "Run Condition", planstate, ancestors, es);
2214 show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
2215 if (plan->qual)
2216 show_instrumentation_count("Rows Removed by Filter", 1,
2217 planstate, es);
2218 show_windowagg_info(castNode(WindowAggState, planstate), es);
2219 break;
2220 case T_Group:
2221 show_group_keys(castNode(GroupState, planstate), ancestors, es);
2222 show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
2223 if (plan->qual)
2224 show_instrumentation_count("Rows Removed by Filter", 1,
2225 planstate, es);
2226 break;
2227 case T_Sort:
2228 show_sort_keys(castNode(SortState, planstate), ancestors, es);
2229 show_sort_info(castNode(SortState, planstate), es);
2230 break;
2231 case T_IncrementalSort:
2232 show_incremental_sort_keys(castNode(IncrementalSortState, planstate),
2233 ancestors, es);
2234 show_incremental_sort_info(castNode(IncrementalSortState, planstate),
2235 es);
2236 break;
2237 case T_MergeAppend:
2238 show_merge_append_keys(castNode(MergeAppendState, planstate),
2239 ancestors, es);
2240 break;
2241 case T_Result:
2242 show_result_replacement_info(castNode(Result, plan), es);
2243 show_upper_qual((List *) ((Result *) plan)->resconstantqual,
2244 "One-Time Filter", planstate, ancestors, es);
2245 show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
2246 if (plan->qual)
2247 show_instrumentation_count("Rows Removed by Filter", 1,
2248 planstate, es);
2249 break;
2250 case T_ModifyTable:
2251 show_modifytable_info(castNode(ModifyTableState, planstate), ancestors,
2252 es);
2253 break;
2254 case T_Hash:
2255 show_hash_info(castNode(HashState, planstate), es);
2256 break;
2257 case T_Material:
2258 show_material_info(castNode(MaterialState, planstate), es);
2259 break;
2260 case T_Memoize:
2261 show_memoize_info(castNode(MemoizeState, planstate), ancestors,
2262 es);
2263 break;
2264 case T_RecursiveUnion:
2265 show_recursive_union_info(castNode(RecursiveUnionState,
2266 planstate), es);
2267 break;
2268 default:
2269 break;
2270 }
2271
2272 /*
2273 * Prepare per-worker JIT instrumentation. As with the overall JIT
2274 * summary, this is printed only if printing costs is enabled.
2275 */
2276 if (es->workers_state && es->costs && es->verbose)
2277 {
2278 SharedJitInstrumentation *w = planstate->worker_jit_instrument;
2279
2280 if (w)
2281 {
2282 for (int n = 0; n < w->num_workers; n++)
2283 {
2284 ExplainOpenWorker(n, es);
2285 ExplainPrintJIT(es, planstate->state->es_jit_flags,
2286 &w->jit_instr[n]);
2287 ExplainCloseWorker(n, es);
2288 }
2289 }
2290 }
2291
2292 /* Show buffer/WAL usage */
2293 if (es->buffers && planstate->instrument)
2294 show_buffer_usage(es, &planstate->instrument->bufusage);
2295 if (es->wal && planstate->instrument)
2296 show_wal_usage(es, &planstate->instrument->walusage);
2297
2298 /* Prepare per-worker buffer/WAL usage */
2299 if (es->workers_state && (es->buffers || es->wal) && es->verbose)
2300 {
2301 WorkerInstrumentation *w = planstate->worker_instrument;
2302
2303 for (int n = 0; n < w->num_workers; n++)
2304 {
2305 Instrumentation *instrument = &w->instrument[n];
2306 double nloops = instrument->nloops;
2307
2308 if (nloops <= 0)
2309 continue;
2310
2311 ExplainOpenWorker(n, es);
2312 if (es->buffers)
2313 show_buffer_usage(es, &instrument->bufusage);
2314 if (es->wal)
2315 show_wal_usage(es, &instrument->walusage);
2316 ExplainCloseWorker(n, es);
2317 }
2318 }
2319
2320 /* Show per-worker details for this plan node, then pop that stack */
2321 if (es->workers_state)
2322 ExplainFlushWorkersState(es);
2323 es->workers_state = save_workers_state;
2324
2325 /* Allow plugins to print additional information */
2326 if (explain_per_node_hook)
2327 (*explain_per_node_hook) (planstate, ancestors, relationship,
2328 plan_name, es);
2329
2330 /*
2331 * If partition pruning was done during executor initialization, the
2332 * number of child plans we'll display below will be less than the number
2333 * of subplans that was specified in the plan. To make this a bit less
2334 * mysterious, emit an indication that this happened. Note that this
2335 * field is emitted now because we want it to be a property of the parent
2336 * node; it *cannot* be emitted within the Plans sub-node we'll open next.
2337 */
2338 switch (nodeTag(plan))
2339 {
2340 case T_Append:
2341 ExplainMissingMembers(((AppendState *) planstate)->as_nplans,
2342 list_length(((Append *) plan)->appendplans),
2343 es);
2344 break;
2345 case T_MergeAppend:
2346 ExplainMissingMembers(((MergeAppendState *) planstate)->ms_nplans,
2347 list_length(((MergeAppend *) plan)->mergeplans),
2348 es);
2349 break;
2350 default:
2351 break;
2352 }
2353
2354 /* Get ready to display the child plans */
2355 haschildren = planstate->initPlan ||
2356 outerPlanState(planstate) ||
2357 innerPlanState(planstate) ||
2358 IsA(plan, Append) ||
2359 IsA(plan, MergeAppend) ||
2360 IsA(plan, BitmapAnd) ||
2361 IsA(plan, BitmapOr) ||
2362 IsA(plan, SubqueryScan) ||
2363 (IsA(planstate, CustomScanState) &&
2364 ((CustomScanState *) planstate)->custom_ps != NIL) ||
2365 planstate->subPlan;
2366 if (haschildren)
2367 {
2368 ExplainOpenGroup("Plans", "Plans", false, es);
2369 /* Pass current Plan as head of ancestors list for children */
2370 ancestors = lcons(plan, ancestors);
2371 }
2372
2373 /* initPlan-s */
2374 if (planstate->initPlan)
2375 ExplainSubPlans(planstate->initPlan, ancestors, "InitPlan", es);
2376
2377 /* lefttree */
2378 if (outerPlanState(planstate))
2379 ExplainNode(outerPlanState(planstate), ancestors,
2380 "Outer", NULL, es);
2381
2382 /* righttree */
2383 if (innerPlanState(planstate))
2384 ExplainNode(innerPlanState(planstate), ancestors,
2385 "Inner", NULL, es);
2386
2387 /* special child plans */
2388 switch (nodeTag(plan))
2389 {
2390 case T_Append:
2391 ExplainMemberNodes(((AppendState *) planstate)->appendplans,
2392 ((AppendState *) planstate)->as_nplans,
2393 ancestors, es);
2394 break;
2395 case T_MergeAppend:
2396 ExplainMemberNodes(((MergeAppendState *) planstate)->mergeplans,
2397 ((MergeAppendState *) planstate)->ms_nplans,
2398 ancestors, es);
2399 break;
2400 case T_BitmapAnd:
2401 ExplainMemberNodes(((BitmapAndState *) planstate)->bitmapplans,
2402 ((BitmapAndState *) planstate)->nplans,
2403 ancestors, es);
2404 break;
2405 case T_BitmapOr:
2406 ExplainMemberNodes(((BitmapOrState *) planstate)->bitmapplans,
2407 ((BitmapOrState *) planstate)->nplans,
2408 ancestors, es);
2409 break;
2410 case T_SubqueryScan:
2411 ExplainNode(((SubqueryScanState *) planstate)->subplan, ancestors,
2412 "Subquery", NULL, es);
2413 break;
2414 case T_CustomScan:
2415 ExplainCustomChildren((CustomScanState *) planstate,
2416 ancestors, es);
2417 break;
2418 default:
2419 break;
2420 }
2421
2422 /* subPlan-s */
2423 if (planstate->subPlan)
2424 ExplainSubPlans(planstate->subPlan, ancestors, "SubPlan", es);
2425
2426 /* end of child plans */
2427 if (haschildren)
2428 {
2429 ancestors = list_delete_first(ancestors);
2430 ExplainCloseGroup("Plans", "Plans", false, es);
2431 }
2432
2433 /* in text format, undo whatever indentation we added */
2434 if (es->format == EXPLAIN_FORMAT_TEXT)
2435 es->indent = save_indent;
2436
2437 ExplainCloseGroup("Plan",
2438 relationship ? NULL : "Plan",
2439 true, es);
2440}
2441
2442/*
2443 * Show the targetlist of a plan node
2444 */
2445static void
2446show_plan_tlist(PlanState *planstate, List *ancestors, ExplainState *es)
2447{
2448 Plan *plan = planstate->plan;
2449 List *context;
2450 List *result = NIL;
2451 bool useprefix;
2452 ListCell *lc;
2453
2454 /* No work if empty tlist (this occurs eg in bitmap indexscans) */
2455 if (plan->targetlist == NIL)
2456 return;
2457 /* The tlist of an Append isn't real helpful, so suppress it */
2458 if (IsA(plan, Append))
2459 return;
2460 /* Likewise for MergeAppend and RecursiveUnion */
2461 if (IsA(plan, MergeAppend))
2462 return;
2463 if (IsA(plan, RecursiveUnion))
2464 return;
2465
2466 /*
2467 * Likewise for ForeignScan that executes a direct INSERT/UPDATE/DELETE
2468 *
2469 * Note: the tlist for a ForeignScan that executes a direct INSERT/UPDATE
2470 * might contain subplan output expressions that are confusing in this
2471 * context. The tlist for a ForeignScan that executes a direct UPDATE/
2472 * DELETE always contains "junk" target columns to identify the exact row
2473 * to update or delete, which would be confusing in this context. So, we
2474 * suppress it in all the cases.
2475 */
2476 if (IsA(plan, ForeignScan) &&
2477 ((ForeignScan *) plan)->operation != CMD_SELECT)
2478 return;
2479
2480 /* Set up deparsing context */
2481 context = set_deparse_context_plan(es->deparse_cxt,
2482 plan,
2483 ancestors);
2484 useprefix = es->rtable_size > 1;
2485
2486 /* Deparse each result column (we now include resjunk ones) */
2487 foreach(lc, plan->targetlist)
2488 {
2489 TargetEntry *tle = (TargetEntry *) lfirst(lc);
2490
2491 result = lappend(result,
2492 deparse_expression((Node *) tle->expr, context,
2493 useprefix, false));
2494 }
2495
2496 /* Print results */
2497 ExplainPropertyList("Output", result, es);
2498}
2499
2500/*
2501 * Show a generic expression
2502 */
2503static void
2504show_expression(Node *node, const char *qlabel,
2505 PlanState *planstate, List *ancestors,
2506 bool useprefix, ExplainState *es)
2507{
2508 List *context;
2509 char *exprstr;
2510
2511 /* Set up deparsing context */
2512 context = set_deparse_context_plan(es->deparse_cxt,
2513 planstate->plan,
2514 ancestors);
2515
2516 /* Deparse the expression */
2517 exprstr = deparse_expression(node, context, useprefix, false);
2518
2519 /* And add to es->str */
2520 ExplainPropertyText(qlabel, exprstr, es);
2521}
2522
2523/*
2524 * Show a qualifier expression (which is a List with implicit AND semantics)
2525 */
2526static void
2527show_qual(List *qual, const char *qlabel,
2528 PlanState *planstate, List *ancestors,
2529 bool useprefix, ExplainState *es)
2530{
2531 Node *node;
2532
2533 /* No work if empty qual */
2534 if (qual == NIL)
2535 return;
2536
2537 /* Convert AND list to explicit AND */
2538 node = (Node *) make_ands_explicit(qual);
2539
2540 /* And show it */
2541 show_expression(node, qlabel, planstate, ancestors, useprefix, es);
2542}
2543
2544/*
2545 * Show a qualifier expression for a scan plan node
2546 */
2547static void
2548show_scan_qual(List *qual, const char *qlabel,
2549 PlanState *planstate, List *ancestors,
2550 ExplainState *es)
2551{
2552 bool useprefix;
2553
2554 useprefix = (IsA(planstate->plan, SubqueryScan) || es->verbose);
2555 show_qual(qual, qlabel, planstate, ancestors, useprefix, es);
2556}
2557
2558/*
2559 * Show a qualifier expression for an upper-level plan node
2560 */
2561static void
2562show_upper_qual(List *qual, const char *qlabel,
2563 PlanState *planstate, List *ancestors,
2564 ExplainState *es)
2565{
2566 bool useprefix;
2567
2568 useprefix = (es->rtable_size > 1 || es->verbose);
2569 show_qual(qual, qlabel, planstate, ancestors, useprefix, es);
2570}
2571
2572/*
2573 * Show the sort keys for a Sort node.
2574 */
2575static void
2576show_sort_keys(SortState *sortstate, List *ancestors, ExplainState *es)
2577{
2578 Sort *plan = (Sort *) sortstate->ss.ps.plan;
2579
2580 show_sort_group_keys((PlanState *) sortstate, "Sort Key",
2581 plan->numCols, 0, plan->sortColIdx,
2582 plan->sortOperators, plan->collations,
2583 plan->nullsFirst,
2584 ancestors, es);
2585}
2586
2587/*
2588 * Show the sort keys for an IncrementalSort node.
2589 */
2590static void
2591show_incremental_sort_keys(IncrementalSortState *incrsortstate,
2592 List *ancestors, ExplainState *es)
2593{
2594 IncrementalSort *plan = (IncrementalSort *) incrsortstate->ss.ps.plan;
2595
2596 show_sort_group_keys((PlanState *) incrsortstate, "Sort Key",
2597 plan->sort.numCols, plan->nPresortedCols,
2598 plan->sort.sortColIdx,
2599 plan->sort.sortOperators, plan->sort.collations,
2600 plan->sort.nullsFirst,
2601 ancestors, es);
2602}
2603
2604/*
2605 * Likewise, for a MergeAppend node.
2606 */
2607static void
2608show_merge_append_keys(MergeAppendState *mstate, List *ancestors,
2609 ExplainState *es)
2610{
2611 MergeAppend *plan = (MergeAppend *) mstate->ps.plan;
2612
2613 show_sort_group_keys((PlanState *) mstate, "Sort Key",
2614 plan->numCols, 0, plan->sortColIdx,
2615 plan->sortOperators, plan->collations,
2616 plan->nullsFirst,
2617 ancestors, es);
2618}
2619
2620/*
2621 * Show the grouping keys for an Agg node.
2622 */
2623static void
2624show_agg_keys(AggState *astate, List *ancestors,
2625 ExplainState *es)
2626{
2627 Agg *plan = (Agg *) astate->ss.ps.plan;
2628
2629 if (plan->numCols > 0 || plan->groupingSets)
2630 {
2631 /* The key columns refer to the tlist of the child plan */
2632 ancestors = lcons(plan, ancestors);
2633
2634 if (plan->groupingSets)
2635 show_grouping_sets(outerPlanState(astate), plan, ancestors, es);
2636 else
2637 show_sort_group_keys(outerPlanState(astate), "Group Key",
2638 plan->numCols, 0, plan->grpColIdx,
2639 NULL, NULL, NULL,
2640 ancestors, es);
2641
2642 ancestors = list_delete_first(ancestors);
2643 }
2644}
2645
2646static void
2647show_grouping_sets(PlanState *planstate, Agg *agg,
2648 List *ancestors, ExplainState *es)
2649{
2650 List *context;
2651 bool useprefix;
2652 ListCell *lc;
2653
2654 /* Set up deparsing context */
2655 context = set_deparse_context_plan(es->deparse_cxt,
2656 planstate->plan,
2657 ancestors);
2658 useprefix = (es->rtable_size > 1 || es->verbose);
2659
2660 ExplainOpenGroup("Grouping Sets", "Grouping Sets", false, es);
2661
2662 show_grouping_set_keys(planstate, agg, NULL,
2663 context, useprefix, ancestors, es);
2664
2665 foreach(lc, agg->chain)
2666 {
2667 Agg *aggnode = lfirst(lc);
2668 Sort *sortnode = (Sort *) aggnode->plan.lefttree;
2669
2670 show_grouping_set_keys(planstate, aggnode, sortnode,
2671 context, useprefix, ancestors, es);
2672 }
2673
2674 ExplainCloseGroup("Grouping Sets", "Grouping Sets", false, es);
2675}
2676
2677static void
2678show_grouping_set_keys(PlanState *planstate,
2679 Agg *aggnode, Sort *sortnode,
2680 List *context, bool useprefix,
2681 List *ancestors, ExplainState *es)
2682{
2683 Plan *plan = planstate->plan;
2684 char *exprstr;
2685 ListCell *lc;
2686 List *gsets = aggnode->groupingSets;
2687 AttrNumber *keycols = aggnode->grpColIdx;
2688 const char *keyname;
2689 const char *keysetname;
2690
2691 if (aggnode->aggstrategy == AGG_HASHED || aggnode->aggstrategy == AGG_MIXED)
2692 {
2693 keyname = "Hash Key";
2694 keysetname = "Hash Keys";
2695 }
2696 else
2697 {
2698 keyname = "Group Key";
2699 keysetname = "Group Keys";
2700 }
2701
2702 ExplainOpenGroup("Grouping Set", NULL, true, es);
2703
2704 if (sortnode)
2705 {
2706 show_sort_group_keys(planstate, "Sort Key",
2707 sortnode->numCols, 0, sortnode->sortColIdx,
2708 sortnode->sortOperators, sortnode->collations,
2709 sortnode->nullsFirst,
2710 ancestors, es);
2711 if (es->format == EXPLAIN_FORMAT_TEXT)
2712 es->indent++;
2713 }
2714
2715 ExplainOpenGroup(keysetname, keysetname, false, es);
2716
2717 foreach(lc, gsets)
2718 {
2719 List *result = NIL;
2720 ListCell *lc2;
2721
2722 foreach(lc2, (List *) lfirst(lc))
2723 {
2724 Index i = lfirst_int(lc2);
2725 AttrNumber keyresno = keycols[i];
2726 TargetEntry *target = get_tle_by_resno(plan->targetlist,
2727 keyresno);
2728
2729 if (!target)
2730 elog(ERROR, "no tlist entry for key %d", keyresno);
2731 /* Deparse the expression, showing any top-level cast */
2732 exprstr = deparse_expression((Node *) target->expr, context,
2733 useprefix, true);
2734
2735 result = lappend(result, exprstr);
2736 }
2737
2738 if (!result && es->format == EXPLAIN_FORMAT_TEXT)
2739 ExplainPropertyText(keyname, "()", es);
2740 else
2741 ExplainPropertyListNested(keyname, result, es);
2742 }
2743
2744 ExplainCloseGroup(keysetname, keysetname, false, es);
2745
2746 if (sortnode && es->format == EXPLAIN_FORMAT_TEXT)
2747 es->indent--;
2748
2749 ExplainCloseGroup("Grouping Set", NULL, true, es);
2750}
2751
2752/*
2753 * Show the grouping keys for a Group node.
2754 */
2755static void
2756show_group_keys(GroupState *gstate, List *ancestors,
2757 ExplainState *es)
2758{
2759 Group *plan = (Group *) gstate->ss.ps.plan;
2760
2761 /* The key columns refer to the tlist of the child plan */
2762 ancestors = lcons(plan, ancestors);
2763 show_sort_group_keys(outerPlanState(gstate), "Group Key",
2764 plan->numCols, 0, plan->grpColIdx,
2765 NULL, NULL, NULL,
2766 ancestors, es);
2767 ancestors = list_delete_first(ancestors);
2768}
2769
2770/*
2771 * Common code to show sort/group keys, which are represented in plan nodes
2772 * as arrays of targetlist indexes. If it's a sort key rather than a group
2773 * key, also pass sort operators/collations/nullsFirst arrays.
2774 */
2775static void
2776show_sort_group_keys(PlanState *planstate, const char *qlabel,
2777 int nkeys, int nPresortedKeys, AttrNumber *keycols,
2778 Oid *sortOperators, Oid *collations, bool *nullsFirst,
2779 List *ancestors, ExplainState *es)
2780{
2781 Plan *plan = planstate->plan;
2782 List *context;
2783 List *result = NIL;
2784 List *resultPresorted = NIL;
2785 StringInfoData sortkeybuf;
2786 bool useprefix;
2787 int keyno;
2788
2789 if (nkeys <= 0)
2790 return;
2791
2792 initStringInfo(&sortkeybuf);
2793
2794 /* Set up deparsing context */
2795 context = set_deparse_context_plan(es->deparse_cxt,
2796 plan,
2797 ancestors);
2798 useprefix = (es->rtable_size > 1 || es->verbose);
2799
2800 for (keyno = 0; keyno < nkeys; keyno++)
2801 {
2802 /* find key expression in tlist */
2803 AttrNumber keyresno = keycols[keyno];
2804 TargetEntry *target = get_tle_by_resno(plan->targetlist,
2805 keyresno);
2806 char *exprstr;
2807
2808 if (!target)
2809 elog(ERROR, "no tlist entry for key %d", keyresno);
2810 /* Deparse the expression, showing any top-level cast */
2811 exprstr = deparse_expression((Node *) target->expr, context,
2812 useprefix, true);
2813 resetStringInfo(&sortkeybuf);
2814 appendStringInfoString(&sortkeybuf, exprstr);
2815 /* Append sort order information, if relevant */
2816 if (sortOperators != NULL)
2817 show_sortorder_options(&sortkeybuf,
2818 (Node *) target->expr,
2819 sortOperators[keyno],
2820 collations[keyno],
2821 nullsFirst[keyno]);
2822 /* Emit one property-list item per sort key */
2823 result = lappend(result, pstrdup(sortkeybuf.data));
2824 if (keyno < nPresortedKeys)
2825 resultPresorted = lappend(resultPresorted, exprstr);
2826 }
2827
2828 ExplainPropertyList(qlabel, result, es);
2829 if (nPresortedKeys > 0)
2830 ExplainPropertyList("Presorted Key", resultPresorted, es);
2831}
2832
2833/*
2834 * Append nondefault characteristics of the sort ordering of a column to buf
2835 * (collation, direction, NULLS FIRST/LAST)
2836 */
2837static void
2838show_sortorder_options(StringInfo buf, Node *sortexpr,
2839 Oid sortOperator, Oid collation, bool nullsFirst)
2840{
2841 Oid sortcoltype = exprType(sortexpr);
2842 bool reverse = false;
2843 TypeCacheEntry *typentry;
2844
2845 typentry = lookup_type_cache(sortcoltype,
2846 TYPECACHE_LT_OPR | TYPECACHE_GT_OPR);
2847
2848 /*
2849 * Print COLLATE if it's not default for the column's type. There are
2850 * some cases where this is redundant, eg if expression is a column whose
2851 * declared collation is that collation, but it's hard to distinguish that
2852 * here (and arguably, printing COLLATE explicitly is a good idea anyway
2853 * in such cases).
2854 */
2855 if (OidIsValid(collation) && collation != get_typcollation(sortcoltype))
2856 {
2857 char *collname = get_collation_name(collation);
2858
2859 if (collname == NULL)
2860 elog(ERROR, "cache lookup failed for collation %u", collation);
2861 appendStringInfo(buf, " COLLATE %s", quote_identifier(collname));
2862 }
2863
2864 /* Print direction if not ASC, or USING if non-default sort operator */
2865 if (sortOperator == typentry->gt_opr)
2866 {
2867 appendStringInfoString(buf, " DESC");
2868 reverse = true;
2869 }
2870 else if (sortOperator != typentry->lt_opr)
2871 {
2872 char *opname = get_opname(sortOperator);
2873
2874 if (opname == NULL)
2875 elog(ERROR, "cache lookup failed for operator %u", sortOperator);
2876 appendStringInfo(buf, " USING %s", opname);
2877 /* Determine whether operator would be considered ASC or DESC */
2878 (void) get_equality_op_for_ordering_op(sortOperator, &reverse);
2879 }
2880
2881 /* Add NULLS FIRST/LAST only if it wouldn't be default */
2882 if (nullsFirst && !reverse)
2883 {
2884 appendStringInfoString(buf, " NULLS FIRST");
2885 }
2886 else if (!nullsFirst && reverse)
2887 {
2888 appendStringInfoString(buf, " NULLS LAST");
2889 }
2890}
2891
2892/*
2893 * Show the window definition for a WindowAgg node.
2894 */
2895static void
2896show_window_def(WindowAggState *planstate, List *ancestors, ExplainState *es)
2897{
2898 WindowAgg *wagg = (WindowAgg *) planstate->ss.ps.plan;
2899 StringInfoData wbuf;
2900 bool needspace = false;
2901
2902 initStringInfo(&wbuf);
2903 appendStringInfo(&wbuf, "%s AS (", quote_identifier(wagg->winname));
2904
2905 /* The key columns refer to the tlist of the child plan */
2906 ancestors = lcons(wagg, ancestors);
2907 if (wagg->partNumCols > 0)
2908 {
2909 appendStringInfoString(&wbuf, "PARTITION BY ");
2910 show_window_keys(&wbuf, outerPlanState(planstate),
2911 wagg->partNumCols, wagg->partColIdx,
2912 ancestors, es);
2913 needspace = true;
2914 }
2915 if (wagg->ordNumCols > 0)
2916 {
2917 if (needspace)
2918 appendStringInfoChar(&wbuf, ' ');
2919 appendStringInfoString(&wbuf, "ORDER BY ");
2920 show_window_keys(&wbuf, outerPlanState(planstate),
2921 wagg->ordNumCols, wagg->ordColIdx,
2922 ancestors, es);
2923 needspace = true;
2924 }
2925 ancestors = list_delete_first(ancestors);
2926 if (wagg->frameOptions & FRAMEOPTION_NONDEFAULT)
2927 {
2928 List *context;
2929 bool useprefix;
2930 char *framestr;
2931
2932 /* Set up deparsing context for possible frame expressions */
2933 context = set_deparse_context_plan(es->deparse_cxt,
2934 (Plan *) wagg,
2935 ancestors);
2936 useprefix = (es->rtable_size > 1 || es->verbose);
2937 framestr = get_window_frame_options_for_explain(wagg->frameOptions,
2938 wagg->startOffset,
2939 wagg->endOffset,
2940 context,
2941 useprefix);
2942 if (needspace)
2943 appendStringInfoChar(&wbuf, ' ');
2944 appendStringInfoString(&wbuf, framestr);
2945 pfree(framestr);
2946 }
2947 appendStringInfoChar(&wbuf, ')');
2948 ExplainPropertyText("Window", wbuf.data, es);
2949 pfree(wbuf.data);
2950}
2951
2952/*
2953 * Append the keys of a window's PARTITION BY or ORDER BY clause to buf.
2954 * We can't use show_sort_group_keys for this because that's too opinionated
2955 * about how the result will be displayed.
2956 * Note that the "planstate" node should be the WindowAgg's child.
2957 */
2958static void
2959show_window_keys(StringInfo buf, PlanState *planstate,
2960 int nkeys, AttrNumber *keycols,
2961 List *ancestors, ExplainState *es)
2962{
2963 Plan *plan = planstate->plan;
2964 List *context;
2965 bool useprefix;
2966
2967 /* Set up deparsing context */
2968 context = set_deparse_context_plan(es->deparse_cxt,
2969 plan,
2970 ancestors);
2971 useprefix = (es->rtable_size > 1 || es->verbose);
2972
2973 for (int keyno = 0; keyno < nkeys; keyno++)
2974 {
2975 /* find key expression in tlist */
2976 AttrNumber keyresno = keycols[keyno];
2977 TargetEntry *target = get_tle_by_resno(plan->targetlist,
2978 keyresno);
2979 char *exprstr;
2980
2981 if (!target)
2982 elog(ERROR, "no tlist entry for key %d", keyresno);
2983 /* Deparse the expression, showing any top-level cast */
2984 exprstr = deparse_expression((Node *) target->expr, context,
2985 useprefix, true);
2986 if (keyno > 0)
2987 appendStringInfoString(buf, ", ");
2988 appendStringInfoString(buf, exprstr);
2989 pfree(exprstr);
2990
2991 /*
2992 * We don't attempt to provide sort order information because
2993 * WindowAgg carries equality operators not comparison operators;
2994 * compare show_agg_keys.
2995 */
2996 }
2997}
2998
2999/*
3000 * Show information on storage method and maximum memory/disk space used.
3001 */
3002static void
3003show_storage_info(char *maxStorageType, int64 maxSpaceUsed, ExplainState *es)
3004{
3005 int64 maxSpaceUsedKB = BYTES_TO_KILOBYTES(maxSpaceUsed);
3006
3007 if (es->format != EXPLAIN_FORMAT_TEXT)
3008 {
3009 ExplainPropertyText("Storage", maxStorageType, es);
3010 ExplainPropertyInteger("Maximum Storage", "kB", maxSpaceUsedKB, es);
3011 }
3012 else
3013 {
3014 ExplainIndentText(es);
3015 appendStringInfo(es->str,
3016 "Storage: %s Maximum Storage: " INT64_FORMAT "kB\n",
3017 maxStorageType,
3018 maxSpaceUsedKB);
3019 }
3020}
3021
3022/*
3023 * Show TABLESAMPLE properties
3024 */
3025static void
3026show_tablesample(TableSampleClause *tsc, PlanState *planstate,
3027 List *ancestors, ExplainState *es)
3028{
3029 List *context;
3030 bool useprefix;
3031 char *method_name;
3032 List *params = NIL;
3033 char *repeatable;
3034 ListCell *lc;
3035
3036 /* Set up deparsing context */
3037 context = set_deparse_context_plan(es->deparse_cxt,
3038 planstate->plan,
3039 ancestors);
3040 useprefix = es->rtable_size > 1;
3041
3042 /* Get the tablesample method name */
3043 method_name = get_func_name(tsc->tsmhandler);
3044
3045 /* Deparse parameter expressions */
3046 foreach(lc, tsc->args)
3047 {
3048 Node *arg = (Node *) lfirst(lc);
3049
3050 params = lappend(params,
3051 deparse_expression(arg, context,
3052 useprefix, false));
3053 }
3054 if (tsc->repeatable)
3055 repeatable = deparse_expression((Node *) tsc->repeatable, context,
3056 useprefix, false);
3057 else
3058 repeatable = NULL;
3059
3060 /* Print results */
3061 if (es->format == EXPLAIN_FORMAT_TEXT)
3062 {
3063 bool first = true;
3064
3065 ExplainIndentText(es);
3066 appendStringInfo(es->str, "Sampling: %s (", method_name);
3067 foreach(lc, params)
3068 {
3069 if (!first)
3070 appendStringInfoString(es->str, ", ");
3071 appendStringInfoString(es->str, (const char *) lfirst(lc));
3072 first = false;
3073 }
3074 appendStringInfoChar(es->str, ')');
3075 if (repeatable)
3076 appendStringInfo(es->str, " REPEATABLE (%s)", repeatable);
3077 appendStringInfoChar(es->str, '\n');
3078 }
3079 else
3080 {
3081 ExplainPropertyText("Sampling Method", method_name, es);
3082 ExplainPropertyList("Sampling Parameters", params, es);
3083 if (repeatable)
3084 ExplainPropertyText("Repeatable Seed", repeatable, es);
3085 }
3086}
3087
3088/*
3089 * If it's EXPLAIN ANALYZE, show tuplesort stats for a sort node
3090 */
3091static void
3092show_sort_info(SortState *sortstate, ExplainState *es)
3093{
3094 if (!es->analyze)
3095 return;
3096
3097 if (sortstate->sort_Done && sortstate->tuplesortstate != NULL)
3098 {
3099 Tuplesortstate *state = (Tuplesortstate *) sortstate->tuplesortstate;
3100 TuplesortInstrumentation stats;
3101 const char *sortMethod;
3102 const char *spaceType;
3103 int64 spaceUsed;
3104
3105 tuplesort_get_stats(state, &stats);
3106 sortMethod = tuplesort_method_name(stats.sortMethod);
3107 spaceType = tuplesort_space_type_name(stats.spaceType);
3108 spaceUsed = stats.spaceUsed;
3109
3110 if (es->format == EXPLAIN_FORMAT_TEXT)
3111 {
3112 ExplainIndentText(es);
3113 appendStringInfo(es->str, "Sort Method: %s %s: " INT64_FORMAT "kB\n",
3114 sortMethod, spaceType, spaceUsed);
3115 }
3116 else
3117 {
3118 ExplainPropertyText("Sort Method", sortMethod, es);
3119 ExplainPropertyInteger("Sort Space Used", "kB", spaceUsed, es);
3120 ExplainPropertyText("Sort Space Type", spaceType, es);
3121 }
3122 }
3123
3124 /*
3125 * You might think we should just skip this stanza entirely when
3126 * es->hide_workers is true, but then we'd get no sort-method output at
3127 * all. We have to make it look like worker 0's data is top-level data.
3128 * This is easily done by just skipping the OpenWorker/CloseWorker calls.
3129 * Currently, we don't worry about the possibility that there are multiple
3130 * workers in such a case; if there are, duplicate output fields will be
3131 * emitted.
3132 */
3133 if (sortstate->shared_info != NULL)
3134 {
3135 int n;
3136
3137 for (n = 0; n < sortstate->shared_info->num_workers; n++)
3138 {
3139 TuplesortInstrumentation *sinstrument;
3140 const char *sortMethod;
3141 const char *spaceType;
3142 int64 spaceUsed;
3143
3144 sinstrument = &sortstate->shared_info->sinstrument[n];
3145 if (sinstrument->sortMethod == SORT_TYPE_STILL_IN_PROGRESS)
3146 continue; /* ignore any unfilled slots */
3147 sortMethod = tuplesort_method_name(sinstrument->sortMethod);
3148 spaceType = tuplesort_space_type_name(sinstrument->spaceType);
3149 spaceUsed = sinstrument->spaceUsed;
3150
3151 if (es->workers_state)
3152 ExplainOpenWorker(n, es);
3153
3154 if (es->format == EXPLAIN_FORMAT_TEXT)
3155 {
3156 ExplainIndentText(es);
3157 appendStringInfo(es->str,
3158 "Sort Method: %s %s: " INT64_FORMAT "kB\n",
3159 sortMethod, spaceType, spaceUsed);
3160 }
3161 else
3162 {
3163 ExplainPropertyText("Sort Method", sortMethod, es);
3164 ExplainPropertyInteger("Sort Space Used", "kB", spaceUsed, es);
3165 ExplainPropertyText("Sort Space Type", spaceType, es);
3166 }
3167
3168 if (es->workers_state)
3169 ExplainCloseWorker(n, es);
3170 }
3171 }
3172}
3173
3174/*
3175 * Incremental sort nodes sort in (a potentially very large number of) batches,
3176 * so EXPLAIN ANALYZE needs to roll up the tuplesort stats from each batch into
3177 * an intelligible summary.
3178 *
3179 * This function is used for both a non-parallel node and each worker in a
3180 * parallel incremental sort node.
3181 */
3182static void
3183show_incremental_sort_group_info(IncrementalSortGroupInfo *groupInfo,
3184 const char *groupLabel, bool indent, ExplainState *es)
3185{
3186 ListCell *methodCell;
3187 List *methodNames = NIL;
3188
3189 /* Generate a list of sort methods used across all groups. */
3190 for (int bit = 0; bit < NUM_TUPLESORTMETHODS; bit++)
3191 {
3192 TuplesortMethod sortMethod = (1 << bit);
3193
3194 if (groupInfo->sortMethods & sortMethod)
3195 {
3196 const char *methodName = tuplesort_method_name(sortMethod);
3197
3198 methodNames = lappend(methodNames, unconstify(char *, methodName));
3199 }
3200 }
3201
3202 if (es->format == EXPLAIN_FORMAT_TEXT)
3203 {
3204 if (indent)
3205 appendStringInfoSpaces(es->str, es->indent * 2);
3206 appendStringInfo(es->str, "%s Groups: " INT64_FORMAT " Sort Method", groupLabel,
3207 groupInfo->groupCount);
3208 /* plural/singular based on methodNames size */
3209 if (list_length(methodNames) > 1)
3210 appendStringInfoString(es->str, "s: ");
3211 else
3212 appendStringInfoString(es->str, ": ");
3213 foreach(methodCell, methodNames)
3214 {
3215 appendStringInfoString(es->str, (char *) methodCell->ptr_value);
3216 if (foreach_current_index(methodCell) < list_length(methodNames) - 1)
3217 appendStringInfoString(es->str, ", ");
3218 }
3219
3220 if (groupInfo->maxMemorySpaceUsed > 0)
3221 {
3222 int64 avgSpace = groupInfo->totalMemorySpaceUsed / groupInfo->groupCount;
3223 const char *spaceTypeName;
3224
3225 spaceTypeName = tuplesort_space_type_name(SORT_SPACE_TYPE_MEMORY);
3226 appendStringInfo(es->str, " Average %s: " INT64_FORMAT "kB Peak %s: " INT64_FORMAT "kB",
3227 spaceTypeName, avgSpace,
3228 spaceTypeName, groupInfo->maxMemorySpaceUsed);
3229 }
3230
3231 if (groupInfo->maxDiskSpaceUsed > 0)
3232 {
3233 int64 avgSpace = groupInfo->totalDiskSpaceUsed / groupInfo->groupCount;
3234
3235 const char *spaceTypeName;
3236
3237 spaceTypeName = tuplesort_space_type_name(SORT_SPACE_TYPE_DISK);
3238 appendStringInfo(es->str, " Average %s: " INT64_FORMAT "kB Peak %s: " INT64_FORMAT "kB",
3239 spaceTypeName, avgSpace,
3240 spaceTypeName, groupInfo->maxDiskSpaceUsed);
3241 }
3242 }
3243 else
3244 {
3245 StringInfoData groupName;
3246
3247 initStringInfo(&groupName);
3248 appendStringInfo(&groupName, "%s Groups", groupLabel);
3249 ExplainOpenGroup("Incremental Sort Groups", groupName.data, true, es);
3250 ExplainPropertyInteger("Group Count", NULL, groupInfo->groupCount, es);
3251
3252 ExplainPropertyList("Sort Methods Used", methodNames, es);
3253
3254 if (groupInfo->maxMemorySpaceUsed > 0)
3255 {
3256 int64 avgSpace = groupInfo->totalMemorySpaceUsed / groupInfo->groupCount;
3257 const char *spaceTypeName;
3258 StringInfoData memoryName;
3259
3260 spaceTypeName = tuplesort_space_type_name(SORT_SPACE_TYPE_MEMORY);
3261 initStringInfo(&memoryName);
3262 appendStringInfo(&memoryName, "Sort Space %s", spaceTypeName);
3263 ExplainOpenGroup("Sort Space", memoryName.data, true, es);
3264
3265 ExplainPropertyInteger("Average Sort Space Used", "kB", avgSpace, es);
3266 ExplainPropertyInteger("Peak Sort Space Used", "kB",
3267 groupInfo->maxMemorySpaceUsed, es);
3268
3269 ExplainCloseGroup("Sort Space", memoryName.data, true, es);
3270 }
3271 if (groupInfo->maxDiskSpaceUsed > 0)
3272 {
3273 int64 avgSpace = groupInfo->totalDiskSpaceUsed / groupInfo->groupCount;
3274 const char *spaceTypeName;
3275 StringInfoData diskName;
3276
3277 spaceTypeName = tuplesort_space_type_name(SORT_SPACE_TYPE_DISK);
3278 initStringInfo(&diskName);
3279 appendStringInfo(&diskName, "Sort Space %s", spaceTypeName);
3280 ExplainOpenGroup("Sort Space", diskName.data, true, es);
3281
3282 ExplainPropertyInteger("Average Sort Space Used", "kB", avgSpace, es);
3283 ExplainPropertyInteger("Peak Sort Space Used", "kB",
3284 groupInfo->maxDiskSpaceUsed, es);
3285
3286 ExplainCloseGroup("Sort Space", diskName.data, true, es);
3287 }
3288
3289 ExplainCloseGroup("Incremental Sort Groups", groupName.data, true, es);
3290 }
3291}
3292
3293/*
3294 * If it's EXPLAIN ANALYZE, show tuplesort stats for an incremental sort node
3295 */
3296static void
3297show_incremental_sort_info(IncrementalSortState *incrsortstate,
3298 ExplainState *es)
3299{
3300 IncrementalSortGroupInfo *fullsortGroupInfo;
3301 IncrementalSortGroupInfo *prefixsortGroupInfo;
3302
3303 fullsortGroupInfo = &incrsortstate->incsort_info.fullsortGroupInfo;
3304
3305 if (!es->analyze)
3306 return;
3307
3308 /*
3309 * Since we never have any prefix groups unless we've first sorted a full
3310 * groups and transitioned modes (copying the tuples into a prefix group),
3311 * we don't need to do anything if there were 0 full groups.
3312 *
3313 * We still have to continue after this block if there are no full groups,
3314 * though, since it's possible that we have workers that did real work
3315 * even if the leader didn't participate.
3316 */
3317 if (fullsortGroupInfo->groupCount > 0)
3318 {
3319 show_incremental_sort_group_info(fullsortGroupInfo, "Full-sort", true, es);
3320 prefixsortGroupInfo = &incrsortstate->incsort_info.prefixsortGroupInfo;
3321 if (prefixsortGroupInfo->groupCount > 0)
3322 {
3323 if (es->format == EXPLAIN_FORMAT_TEXT)
3324 appendStringInfoChar(es->str, '\n');
3325 show_incremental_sort_group_info(prefixsortGroupInfo, "Pre-sorted", true, es);
3326 }
3327 if (es->format == EXPLAIN_FORMAT_TEXT)
3328 appendStringInfoChar(es->str, '\n');
3329 }
3330
3331 if (incrsortstate->shared_info != NULL)
3332 {
3333 int n;
3334 bool indent_first_line;
3335
3336 for (n = 0; n < incrsortstate->shared_info->num_workers; n++)
3337 {
3338 IncrementalSortInfo *incsort_info =
3339 &incrsortstate->shared_info->sinfo[n];
3340
3341 /*
3342 * If a worker hasn't processed any sort groups at all, then
3343 * exclude it from output since it either didn't launch or didn't
3344 * contribute anything meaningful.
3345 */
3346 fullsortGroupInfo = &incsort_info->fullsortGroupInfo;
3347
3348 /*
3349 * Since we never have any prefix groups unless we've first sorted
3350 * a full groups and transitioned modes (copying the tuples into a
3351 * prefix group), we don't need to do anything if there were 0
3352 * full groups.
3353 */
3354 if (fullsortGroupInfo->groupCount == 0)
3355 continue;
3356
3357 if (es->workers_state)
3358 ExplainOpenWorker(n, es);
3359
3360 indent_first_line = es->workers_state == NULL || es->verbose;
3361 show_incremental_sort_group_info(fullsortGroupInfo, "Full-sort",
3362 indent_first_line, es);
3363 prefixsortGroupInfo = &incsort_info->prefixsortGroupInfo;
3364 if (prefixsortGroupInfo->groupCount > 0)
3365 {
3366 if (es->format == EXPLAIN_FORMAT_TEXT)
3367 appendStringInfoChar(es->str, '\n');
3368 show_incremental_sort_group_info(prefixsortGroupInfo, "Pre-sorted", true, es);
3369 }
3370 if (es->format == EXPLAIN_FORMAT_TEXT)
3371 appendStringInfoChar(es->str, '\n');
3372
3373 if (es->workers_state)
3374 ExplainCloseWorker(n, es);
3375 }
3376 }
3377}
3378
3379/*
3380 * Show information on hash buckets/batches.
3381 */
3382static void
3383show_hash_info(HashState *hashstate, ExplainState *es)
3384{
3385 HashInstrumentation hinstrument = {0};
3386
3387 /*
3388 * Collect stats from the local process, even when it's a parallel query.
3389 * In a parallel query, the leader process may or may not have run the
3390 * hash join, and even if it did it may not have built a hash table due to
3391 * timing (if it started late it might have seen no tuples in the outer
3392 * relation and skipped building the hash table). Therefore we have to be
3393 * prepared to get instrumentation data from all participants.
3394 */
3395 if (hashstate->hinstrument)
3396 memcpy(&hinstrument, hashstate->hinstrument,
3397 sizeof(HashInstrumentation));
3398
3399 /*
3400 * Merge results from workers. In the parallel-oblivious case, the
3401 * results from all participants should be identical, except where
3402 * participants didn't run the join at all so have no data. In the
3403 * parallel-aware case, we need to consider all the results. Each worker
3404 * may have seen a different subset of batches and we want to report the
3405 * highest memory usage across all batches. We take the maxima of other
3406 * values too, for the same reasons as in ExecHashAccumInstrumentation.
3407 */
3408 if (hashstate->shared_info)
3409 {
3410 SharedHashInfo *shared_info = hashstate->shared_info;
3411 int i;
3412
3413 for (i = 0; i < shared_info->num_workers; ++i)
3414 {
3415 HashInstrumentation *worker_hi = &shared_info->hinstrument[i];
3416
3417 hinstrument.nbuckets = Max(hinstrument.nbuckets,
3418 worker_hi->nbuckets);
3419 hinstrument.nbuckets_original = Max(hinstrument.nbuckets_original,
3420 worker_hi->nbuckets_original);
3421 hinstrument.nbatch = Max(hinstrument.nbatch,
3422 worker_hi->nbatch);
3423 hinstrument.nbatch_original = Max(hinstrument.nbatch_original,
3424 worker_hi->nbatch_original);
3425 hinstrument.space_peak = Max(hinstrument.space_peak,
3426 worker_hi->space_peak);
3427 }
3428 }
3429
3430 if (hinstrument.nbatch > 0)
3431 {
3432 uint64 spacePeakKb = BYTES_TO_KILOBYTES(hinstrument.space_peak);
3433
3434 if (es->format != EXPLAIN_FORMAT_TEXT)
3435 {
3436 ExplainPropertyInteger("Hash Buckets", NULL,
3437 hinstrument.nbuckets, es);
3438 ExplainPropertyInteger("Original Hash Buckets", NULL,
3439 hinstrument.nbuckets_original, es);
3440 ExplainPropertyInteger("Hash Batches", NULL,
3441 hinstrument.nbatch, es);
3442 ExplainPropertyInteger("Original Hash Batches", NULL,
3443 hinstrument.nbatch_original, es);
3444 ExplainPropertyUInteger("Peak Memory Usage", "kB",
3445 spacePeakKb, es);
3446 }
3447 else if (hinstrument.nbatch_original != hinstrument.nbatch ||
3448 hinstrument.nbuckets_original != hinstrument.nbuckets)
3449 {
3450 ExplainIndentText(es);
3451 appendStringInfo(es->str,
3452 "Buckets: %d (originally %d) Batches: %d (originally %d) Memory Usage: " UINT64_FORMAT "kB\n",
3453 hinstrument.nbuckets,
3454 hinstrument.nbuckets_original,
3455 hinstrument.nbatch,
3456 hinstrument.nbatch_original,
3457 spacePeakKb);
3458 }
3459 else
3460 {
3461 ExplainIndentText(es);
3462 appendStringInfo(es->str,
3463 "Buckets: %d Batches: %d Memory Usage: " UINT64_FORMAT "kB\n",
3464 hinstrument.nbuckets, hinstrument.nbatch,
3465 spacePeakKb);
3466 }
3467 }
3468}
3469
3470/*
3471 * Show information on material node, storage method and maximum memory/disk
3472 * space used.
3473 */
3474static void
3475show_material_info(MaterialState *mstate, ExplainState *es)
3476{
3477 char *maxStorageType;
3478 int64 maxSpaceUsed;
3479
3480 Tuplestorestate *tupstore = mstate->tuplestorestate;
3481
3482 /*
3483 * Nothing to show if ANALYZE option wasn't used or if execution didn't
3484 * get as far as creating the tuplestore.
3485 */
3486 if (!es->analyze || tupstore == NULL)
3487 return;
3488
3489 tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
3490 show_storage_info(maxStorageType, maxSpaceUsed, es);
3491}
3492
3493/*
3494 * Show information on WindowAgg node, storage method and maximum memory/disk
3495 * space used.
3496 */
3497static void
3498show_windowagg_info(WindowAggState *winstate, ExplainState *es)
3499{
3500 char *maxStorageType;
3501 int64 maxSpaceUsed;
3502
3503 Tuplestorestate *tupstore = winstate->buffer;
3504
3505 /*
3506 * Nothing to show if ANALYZE option wasn't used or if execution didn't
3507 * get as far as creating the tuplestore.
3508 */
3509 if (!es->analyze || tupstore == NULL)
3510 return;
3511
3512 tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
3513 show_storage_info(maxStorageType, maxSpaceUsed, es);
3514}
3515
3516/*
3517 * Show information on CTE Scan node, storage method and maximum memory/disk
3518 * space used.
3519 */
3520static void
3521show_ctescan_info(CteScanState *ctescanstate, ExplainState *es)
3522{
3523 char *maxStorageType;
3524 int64 maxSpaceUsed;
3525
3526 Tuplestorestate *tupstore = ctescanstate->leader->cte_table;
3527
3528 if (!es->analyze || tupstore == NULL)
3529 return;
3530
3531 tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
3532 show_storage_info(maxStorageType, maxSpaceUsed, es);
3533}
3534
3535/*
3536 * Show information on Table Function Scan node, storage method and maximum
3537 * memory/disk space used.
3538 */
3539static void
3540show_table_func_scan_info(TableFuncScanState *tscanstate, ExplainState *es)
3541{
3542 char *maxStorageType;
3543 int64 maxSpaceUsed;
3544
3545 Tuplestorestate *tupstore = tscanstate->tupstore;
3546
3547 if (!es->analyze || tupstore == NULL)
3548 return;
3549
3550 tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
3551 show_storage_info(maxStorageType, maxSpaceUsed, es);
3552}
3553
3554/*
3555 * Show information on Recursive Union node, storage method and maximum
3556 * memory/disk space used.
3557 */
3558static void
3559show_recursive_union_info(RecursiveUnionState *rstate, ExplainState *es)
3560{
3561 char *maxStorageType,
3562 *tempStorageType;
3563 int64 maxSpaceUsed,
3564 tempSpaceUsed;
3565
3566 if (!es->analyze)
3567 return;
3568
3569 /*
3570 * Recursive union node uses two tuplestores. We employ the storage type
3571 * from one of them which consumed more memory/disk than the other. The
3572 * storage size is sum of the two.
3573 */
3574 tuplestore_get_stats(rstate->working_table, &tempStorageType,
3575 &tempSpaceUsed);
3576 tuplestore_get_stats(rstate->intermediate_table, &maxStorageType,
3577 &maxSpaceUsed);
3578
3579 if (tempSpaceUsed > maxSpaceUsed)
3580 maxStorageType = tempStorageType;
3581
3582 maxSpaceUsed += tempSpaceUsed;
3583 show_storage_info(maxStorageType, maxSpaceUsed, es);
3584}
3585
3586/*
3587 * Show information on memoize hits/misses/evictions and memory usage.
3588 */
3589static void
3590show_memoize_info(MemoizeState *mstate, List *ancestors, ExplainState *es)
3591{
3592 Plan *plan = ((PlanState *) mstate)->plan;
3593 Memoize *mplan = (Memoize *) plan;
3594 ListCell *lc;
3595 List *context;
3596 StringInfoData keystr;
3597 char *separator = "";
3598 bool useprefix;
3599 int64 memPeakKb;
3600
3601 initStringInfo(&keystr);
3602
3603 /*
3604 * It's hard to imagine having a memoize node with fewer than 2 RTEs, but
3605 * let's just keep the same useprefix logic as elsewhere in this file.
3606 */
3607 useprefix = es->rtable_size > 1 || es->verbose;
3608
3609 /* Set up deparsing context */
3610 context = set_deparse_context_plan(es->deparse_cxt,
3611 plan,
3612 ancestors);
3613
3614 foreach(lc, mplan->param_exprs)
3615 {
3616 Node *expr = (Node *) lfirst(lc);
3617
3618 appendStringInfoString(&keystr, separator);
3619
3620 appendStringInfoString(&keystr, deparse_expression(expr, context,
3621 useprefix, false));
3622 separator = ", ";
3623 }
3624
3625 ExplainPropertyText("Cache Key", keystr.data, es);
3626 ExplainPropertyText("Cache Mode", mstate->binary_mode ? "binary" : "logical", es);
3627
3628 pfree(keystr.data);
3629
3630 if (es->costs)
3631 {
3632 if (es->format == EXPLAIN_FORMAT_TEXT)
3633 {
3634 ExplainIndentText(es);
3635 appendStringInfo(es->str, "Estimates: capacity=%u distinct keys=%.0f lookups=%.0f hit percent=%.2f%%\n",
3636 mplan->est_entries, mplan->est_unique_keys,
3637 mplan->est_calls, mplan->est_hit_ratio * 100.0);
3638 }
3639 else
3640 {
3641 ExplainPropertyUInteger("Estimated Capacity", NULL, mplan->est_entries, es);
3642 ExplainPropertyFloat("Estimated Distinct Lookup Keys", NULL, mplan->est_unique_keys, 0, es);
3643 ExplainPropertyFloat("Estimated Lookups", NULL, mplan->est_calls, 0, es);
3644 ExplainPropertyFloat("Estimated Hit Percent", NULL, mplan->est_hit_ratio * 100.0, 2, es);
3645 }
3646 }
3647
3648 if (!es->analyze)
3649 return;
3650
3651 if (mstate->stats.cache_misses > 0)
3652 {
3653 /*
3654 * mem_peak is only set when we freed memory, so we must use mem_used
3655 * when mem_peak is 0.
3656 */
3657 if (mstate->stats.mem_peak > 0)
3658 memPeakKb = BYTES_TO_KILOBYTES(mstate->stats.mem_peak);
3659 else
3660 memPeakKb = BYTES_TO_KILOBYTES(mstate->mem_used);
3661
3662 if (es->format != EXPLAIN_FORMAT_TEXT)
3663 {
3664 ExplainPropertyInteger("Cache Hits", NULL, mstate->stats.cache_hits, es);
3665 ExplainPropertyInteger("Cache Misses", NULL, mstate->stats.cache_misses, es);
3666 ExplainPropertyInteger("Cache Evictions", NULL, mstate->stats.cache_evictions, es);
3667 ExplainPropertyInteger("Cache Overflows", NULL, mstate->stats.cache_overflows, es);
3668 ExplainPropertyInteger("Peak Memory Usage", "kB", memPeakKb, es);
3669 }
3670 else
3671 {
3672 ExplainIndentText(es);
3673 appendStringInfo(es->str,
3674 "Hits: " UINT64_FORMAT " Misses: " UINT64_FORMAT " Evictions: " UINT64_FORMAT " Overflows: " UINT64_FORMAT " Memory Usage: " INT64_FORMAT "kB\n",
3675 mstate->stats.cache_hits,
3676 mstate->stats.cache_misses,
3677 mstate->stats.cache_evictions,
3678 mstate->stats.cache_overflows,
3679 memPeakKb);
3680 }
3681 }
3682
3683 if (mstate->shared_info == NULL)
3684 return;
3685
3686 /* Show details from parallel workers */
3687 for (int n = 0; n < mstate->shared_info->num_workers; n++)
3688 {
3689 MemoizeInstrumentation *si;
3690
3691 si = &mstate->shared_info->sinstrument[n];
3692
3693 /*
3694 * Skip workers that didn't do any work. We needn't bother checking
3695 * for cache hits as a miss will always occur before a cache hit.
3696 */
3697 if (si->cache_misses == 0)
3698 continue;
3699
3700 if (es->workers_state)
3701 ExplainOpenWorker(n, es);
3702
3703 /*
3704 * Since the worker's MemoizeState.mem_used field is unavailable to
3705 * us, ExecEndMemoize will have set the
3706 * MemoizeInstrumentation.mem_peak field for us. No need to do the
3707 * zero checks like we did for the serial case above.
3708 */
3709 memPeakKb = BYTES_TO_KILOBYTES(si->mem_peak);
3710
3711 if (es->format == EXPLAIN_FORMAT_TEXT)
3712 {
3713 ExplainIndentText(es);
3714 appendStringInfo(es->str,
3715 "Hits: " UINT64_FORMAT " Misses: " UINT64_FORMAT " Evictions: " UINT64_FORMAT " Overflows: " UINT64_FORMAT " Memory Usage: " INT64_FORMAT "kB\n",
3716 si->cache_hits, si->cache_misses,
3717 si->cache_evictions, si->cache_overflows,
3718 memPeakKb);
3719 }
3720 else
3721 {
3722 ExplainPropertyInteger("Cache Hits", NULL,
3723 si->cache_hits, es);
3724 ExplainPropertyInteger("Cache Misses", NULL,
3725 si->cache_misses, es);
3726 ExplainPropertyInteger("Cache Evictions", NULL,
3727 si->cache_evictions, es);
3728 ExplainPropertyInteger("Cache Overflows", NULL,
3729 si->cache_overflows, es);
3730 ExplainPropertyInteger("Peak Memory Usage", "kB", memPeakKb,
3731 es);
3732 }
3733
3734 if (es->workers_state)
3735 ExplainCloseWorker(n, es);
3736 }
3737}
3738
3739/*
3740 * Show information on hash aggregate memory usage and batches.
3741 */
3742static void
3743show_hashagg_info(AggState *aggstate, ExplainState *es)
3744{
3745 Agg *agg = (Agg *) aggstate->ss.ps.plan;
3746 int64 memPeakKb = BYTES_TO_KILOBYTES(aggstate->hash_mem_peak);
3747
3748 if (agg->aggstrategy != AGG_HASHED &&
3749 agg->aggstrategy != AGG_MIXED)
3750 return;
3751
3752 if (es->format != EXPLAIN_FORMAT_TEXT)
3753 {
3754 if (es->costs)
3755 ExplainPropertyInteger("Planned Partitions", NULL,
3756 aggstate->hash_planned_partitions, es);
3757
3758 /*
3759 * During parallel query the leader may have not helped out. We
3760 * detect this by checking how much memory it used. If we find it
3761 * didn't do any work then we don't show its properties.
3762 */
3763 if (es->analyze && aggstate->hash_mem_peak > 0)
3764 {
3765 ExplainPropertyInteger("HashAgg Batches", NULL,
3766 aggstate->hash_batches_used, es);
3767 ExplainPropertyInteger("Peak Memory Usage", "kB", memPeakKb, es);
3768 ExplainPropertyInteger("Disk Usage", "kB",
3769 aggstate->hash_disk_used, es);
3770 }
3771 }
3772 else
3773 {
3774 bool gotone = false;
3775
3776 if (es->costs && aggstate->hash_planned_partitions > 0)
3777 {
3778 ExplainIndentText(es);
3779 appendStringInfo(es->str, "Planned Partitions: %d",
3780 aggstate->hash_planned_partitions);
3781 gotone = true;
3782 }
3783
3784 /*
3785 * During parallel query the leader may have not helped out. We
3786 * detect this by checking how much memory it used. If we find it
3787 * didn't do any work then we don't show its properties.
3788 */
3789 if (es->analyze && aggstate->hash_mem_peak > 0)
3790 {
3791 if (!gotone)
3792 ExplainIndentText(es);
3793 else
3794 appendStringInfoSpaces(es->str, 2);
3795
3796 appendStringInfo(es->str, "Batches: %d Memory Usage: " INT64_FORMAT "kB",
3797 aggstate->hash_batches_used, memPeakKb);
3798 gotone = true;
3799
3800 /* Only display disk usage if we spilled to disk */
3801 if (aggstate->hash_batches_used > 1)
3802 {
3803 appendStringInfo(es->str, " Disk Usage: " UINT64_FORMAT "kB",
3804 aggstate->hash_disk_used);
3805 }
3806 }
3807
3808 if (gotone)
3809 appendStringInfoChar(es->str, '\n');
3810 }
3811
3812 /* Display stats for each parallel worker */
3813 if (es->analyze && aggstate->shared_info != NULL)
3814 {
3815 for (int n = 0; n < aggstate->shared_info->num_workers; n++)
3816 {
3817 AggregateInstrumentation *sinstrument;
3818 uint64 hash_disk_used;
3819 int hash_batches_used;
3820
3821 sinstrument = &aggstate->shared_info->sinstrument[n];
3822 /* Skip workers that didn't do anything */
3823 if (sinstrument->hash_mem_peak == 0)
3824 continue;
3825 hash_disk_used = sinstrument->hash_disk_used;
3826 hash_batches_used = sinstrument->hash_batches_used;
3827 memPeakKb = BYTES_TO_KILOBYTES(sinstrument->hash_mem_peak);
3828
3829 if (es->workers_state)
3830 ExplainOpenWorker(n, es);
3831
3832 if (es->format == EXPLAIN_FORMAT_TEXT)
3833 {
3834 ExplainIndentText(es);
3835
3836 appendStringInfo(es->str, "Batches: %d Memory Usage: " INT64_FORMAT "kB",
3837 hash_batches_used, memPeakKb);
3838
3839 /* Only display disk usage if we spilled to disk */
3840 if (hash_batches_used > 1)
3841 appendStringInfo(es->str, " Disk Usage: " UINT64_FORMAT "kB",
3842 hash_disk_used);
3843 appendStringInfoChar(es->str, '\n');
3844 }
3845 else
3846 {
3847 ExplainPropertyInteger("HashAgg Batches", NULL,
3848 hash_batches_used, es);
3849 ExplainPropertyInteger("Peak Memory Usage", "kB", memPeakKb,
3850 es);
3851 ExplainPropertyInteger("Disk Usage", "kB", hash_disk_used, es);
3852 }
3853
3854 if (es->workers_state)
3855 ExplainCloseWorker(n, es);
3856 }
3857 }
3858}
3859
3860/*
3861 * Show the total number of index searches for a
3862 * IndexScan/IndexOnlyScan/BitmapIndexScan node
3863 */
3864static void
3865show_indexsearches_info(PlanState *planstate, ExplainState *es)
3866{
3867 Plan *plan = planstate->plan;
3868 SharedIndexScanInstrumentation *SharedInfo = NULL;
3869 uint64 nsearches = 0;
3870
3871 if (!es->analyze)
3872 return;
3873
3874 /* Initialize counters with stats from the local process first */
3875 switch (nodeTag(plan))
3876 {
3877 case T_IndexScan:
3878 {
3879 IndexScanState *indexstate = ((IndexScanState *) planstate);
3880
3881 nsearches = indexstate->iss_Instrument.nsearches;
3882 SharedInfo = indexstate->iss_SharedInfo;
3883 break;
3884 }
3885 case T_IndexOnlyScan:
3886 {
3887 IndexOnlyScanState *indexstate = ((IndexOnlyScanState *) planstate);
3888
3889 nsearches = indexstate->ioss_Instrument.nsearches;
3890 SharedInfo = indexstate->ioss_SharedInfo;
3891 break;
3892 }
3893 case T_BitmapIndexScan:
3894 {
3895 BitmapIndexScanState *indexstate = ((BitmapIndexScanState *) planstate);
3896
3897 nsearches = indexstate->biss_Instrument.nsearches;
3898 SharedInfo = indexstate->biss_SharedInfo;
3899 break;
3900 }
3901 default:
3902 break;
3903 }
3904
3905 /* Next get the sum of the counters set within each and every process */
3906 if (SharedInfo)
3907 {
3908 for (int i = 0; i < SharedInfo->num_workers; ++i)
3909 {
3910 IndexScanInstrumentation *winstrument = &SharedInfo->winstrument[i];
3911
3912 nsearches += winstrument->nsearches;
3913 }
3914 }
3915
3916 ExplainPropertyUInteger("Index Searches", NULL, nsearches, es);
3917}
3918
3919/*
3920 * Show exact/lossy pages for a BitmapHeapScan node
3921 */
3922static void
3923show_tidbitmap_info(BitmapHeapScanState *planstate, ExplainState *es)
3924{
3925 if (!es->analyze)
3926 return;
3927
3928 if (es->format != EXPLAIN_FORMAT_TEXT)
3929 {
3930 ExplainPropertyUInteger("Exact Heap Blocks", NULL,
3931 planstate->stats.exact_pages, es);
3932 ExplainPropertyUInteger("Lossy Heap Blocks", NULL,
3933 planstate->stats.lossy_pages, es);
3934 }
3935 else
3936 {
3937 if (planstate->stats.exact_pages > 0 || planstate->stats.lossy_pages > 0)
3938 {
3939 ExplainIndentText(es);
3940 appendStringInfoString(es->str, "Heap Blocks:");
3941 if (planstate->stats.exact_pages > 0)
3942 appendStringInfo(es->str, " exact=" UINT64_FORMAT, planstate->stats.exact_pages);
3943 if (planstate->stats.lossy_pages > 0)
3944 appendStringInfo(es->str, " lossy=" UINT64_FORMAT, planstate->stats.lossy_pages);
3945 appendStringInfoChar(es->str, '\n');
3946 }
3947 }
3948
3949 /* Display stats for each parallel worker */
3950 if (planstate->pstate != NULL)
3951 {
3952 for (int n = 0; n < planstate->sinstrument->num_workers; n++)
3953 {
3954 BitmapHeapScanInstrumentation *si = &planstate->sinstrument->sinstrument[n];
3955
3956 if (si->exact_pages == 0 && si->lossy_pages == 0)
3957 continue;
3958
3959 if (es->workers_state)
3960 ExplainOpenWorker(n, es);
3961
3962 if (es->format == EXPLAIN_FORMAT_TEXT)
3963 {
3964 ExplainIndentText(es);
3965 appendStringInfoString(es->str, "Heap Blocks:");
3966 if (si->exact_pages > 0)
3967 appendStringInfo(es->str, " exact=" UINT64_FORMAT, si->exact_pages);
3968 if (si->lossy_pages > 0)
3969 appendStringInfo(es->str, " lossy=" UINT64_FORMAT, si->lossy_pages);
3970 appendStringInfoChar(es->str, '\n');
3971 }
3972 else
3973 {
3974 ExplainPropertyUInteger("Exact Heap Blocks", NULL,
3975 si->exact_pages, es);
3976 ExplainPropertyUInteger("Lossy Heap Blocks", NULL,
3977 si->lossy_pages, es);
3978 }
3979
3980 if (es->workers_state)
3981 ExplainCloseWorker(n, es);
3982 }
3983 }
3984}
3985
3986/*
3987 * If it's EXPLAIN ANALYZE, show instrumentation information for a plan node
3988 *
3989 * "which" identifies which instrumentation counter to print
3990 */
3991static void
3992show_instrumentation_count(const char *qlabel, int which,
3993 PlanState *planstate, ExplainState *es)
3994{
3995 double nfiltered;
3996 double nloops;
3997
3998 if (!es->analyze || !planstate->instrument)
3999 return;
4000
4001 if (which == 2)
4002 nfiltered = planstate->instrument->nfiltered2;
4003 else
4004 nfiltered = planstate->instrument->nfiltered1;
4005 nloops = planstate->instrument->nloops;
4006
4007 /* In text mode, suppress zero counts; they're not interesting enough */
4008 if (nfiltered > 0 || es->format != EXPLAIN_FORMAT_TEXT)
4009 {
4010 if (nloops > 0)
4011 ExplainPropertyFloat(qlabel, NULL, nfiltered / nloops, 0, es);
4012 else
4013 ExplainPropertyFloat(qlabel, NULL, 0.0, 0, es);
4014 }
4015}
4016
4017/*
4018 * Show extra information for a ForeignScan node.
4019 */
4020static void
4021show_foreignscan_info(ForeignScanState *fsstate, ExplainState *es)
4022{
4023 FdwRoutine *fdwroutine = fsstate->fdwroutine;
4024
4025 /* Let the FDW emit whatever fields it wants */
4026 if (((ForeignScan *) fsstate->ss.ps.plan)->operation != CMD_SELECT)
4027 {
4028 if (fdwroutine->ExplainDirectModify != NULL)
4029 fdwroutine->ExplainDirectModify(fsstate, es);
4030 }
4031 else
4032 {
4033 if (fdwroutine->ExplainForeignScan != NULL)
4034 fdwroutine->ExplainForeignScan(fsstate, es);
4035 }
4036}
4037
4038/*
4039 * Fetch the name of an index in an EXPLAIN
4040 *
4041 * We allow plugins to get control here so that plans involving hypothetical
4042 * indexes can be explained.
4043 *
4044 * Note: names returned by this function should be "raw"; the caller will
4045 * apply quoting if needed. Formerly the convention was to do quoting here,
4046 * but we don't want that in non-text output formats.
4047 */
4048static const char *
4049explain_get_index_name(Oid indexId)
4050{
4051 const char *result;
4052
4053 if (explain_get_index_name_hook)
4054 result = (*explain_get_index_name_hook) (indexId);
4055 else
4056 result = NULL;
4057 if (result == NULL)
4058 {
4059 /* default behavior: look it up in the catalogs */
4060 result = get_rel_name(indexId);
4061 if (result == NULL)
4062 elog(ERROR, "cache lookup failed for index %u", indexId);
4063 }
4064 return result;
4065}
4066
4067/*
4068 * Return whether show_buffer_usage would have anything to print, if given
4069 * the same 'usage' data. Note that when the format is anything other than
4070 * text, we print even if the counters are all zeroes.
4071 */
4072static bool
4073peek_buffer_usage(ExplainState *es, const BufferUsage *usage)
4074{
4075 bool has_shared;
4076 bool has_local;
4077 bool has_temp;
4078 bool has_shared_timing;
4079 bool has_local_timing;
4080 bool has_temp_timing;
4081
4082 if (usage == NULL)
4083 return false;
4084
4085 if (es->format != EXPLAIN_FORMAT_TEXT)
4086 return true;
4087
4088 has_shared = (usage->shared_blks_hit > 0 ||
4089 usage->shared_blks_read > 0 ||
4090 usage->shared_blks_dirtied > 0 ||
4091 usage->shared_blks_written > 0);
4092 has_local = (usage->local_blks_hit > 0 ||
4093 usage->local_blks_read > 0 ||
4094 usage->local_blks_dirtied > 0 ||
4095 usage->local_blks_written > 0);
4096 has_temp = (usage->temp_blks_read > 0 ||
4097 usage->temp_blks_written > 0);
4098 has_shared_timing = (!INSTR_TIME_IS_ZERO(usage->shared_blk_read_time) ||
4099 !INSTR_TIME_IS_ZERO(usage->shared_blk_write_time));
4100 has_local_timing = (!INSTR_TIME_IS_ZERO(usage->local_blk_read_time) ||
4101 !INSTR_TIME_IS_ZERO(usage->local_blk_write_time));
4102 has_temp_timing = (!INSTR_TIME_IS_ZERO(usage->temp_blk_read_time) ||
4103 !INSTR_TIME_IS_ZERO(usage->temp_blk_write_time));
4104
4105 return has_shared || has_local || has_temp || has_shared_timing ||
4106 has_local_timing || has_temp_timing;
4107}
4108
4109/*
4110 * Show buffer usage details. This better be sync with peek_buffer_usage.
4111 */
4112static void
4113show_buffer_usage(ExplainState *es, const BufferUsage *usage)
4114{
4115 if (es->format == EXPLAIN_FORMAT_TEXT)
4116 {
4117 bool has_shared = (usage->shared_blks_hit > 0 ||
4118 usage->shared_blks_read > 0 ||
4119 usage->shared_blks_dirtied > 0 ||
4120 usage->shared_blks_written > 0);
4121 bool has_local = (usage->local_blks_hit > 0 ||
4122 usage->local_blks_read > 0 ||
4123 usage->local_blks_dirtied > 0 ||
4124 usage->local_blks_written > 0);
4125 bool has_temp = (usage->temp_blks_read > 0 ||
4126 usage->temp_blks_written > 0);
4127 bool has_shared_timing = (!INSTR_TIME_IS_ZERO(usage->shared_blk_read_time) ||
4128 !INSTR_TIME_IS_ZERO(usage->shared_blk_write_time));
4129 bool has_local_timing = (!INSTR_TIME_IS_ZERO(usage->local_blk_read_time) ||
4130 !INSTR_TIME_IS_ZERO(usage->local_blk_write_time));
4131 bool has_temp_timing = (!INSTR_TIME_IS_ZERO(usage->temp_blk_read_time) ||
4132 !INSTR_TIME_IS_ZERO(usage->temp_blk_write_time));
4133
4134 /* Show only positive counter values. */
4135 if (has_shared || has_local || has_temp)
4136 {
4137 ExplainIndentText(es);
4138 appendStringInfoString(es->str, "Buffers:");
4139
4140 if (has_shared)
4141 {
4142 appendStringInfoString(es->str, " shared");
4143 if (usage->shared_blks_hit > 0)
4144 appendStringInfo(es->str, " hit=%" PRId64,
4145 usage->shared_blks_hit);
4146 if (usage->shared_blks_read > 0)
4147 appendStringInfo(es->str, " read=%" PRId64,
4148 usage->shared_blks_read);
4149 if (usage->shared_blks_dirtied > 0)
4150 appendStringInfo(es->str, " dirtied=%" PRId64,
4151 usage->shared_blks_dirtied);
4152 if (usage->shared_blks_written > 0)
4153 appendStringInfo(es->str, " written=%" PRId64,
4154 usage->shared_blks_written);
4155 if (has_local || has_temp)
4156 appendStringInfoChar(es->str, ',');
4157 }
4158 if (has_local)
4159 {
4160 appendStringInfoString(es->str, " local");
4161 if (usage->local_blks_hit > 0)
4162 appendStringInfo(es->str, " hit=%" PRId64,
4163 usage->local_blks_hit);
4164 if (usage->local_blks_read > 0)
4165 appendStringInfo(es->str, " read=%" PRId64,
4166 usage->local_blks_read);
4167 if (usage->local_blks_dirtied > 0)
4168 appendStringInfo(es->str, " dirtied=%" PRId64,
4169 usage->local_blks_dirtied);
4170 if (usage->local_blks_written > 0)
4171 appendStringInfo(es->str, " written=%" PRId64,
4172 usage->local_blks_written);
4173 if (has_temp)
4174 appendStringInfoChar(es->str, ',');
4175 }
4176 if (has_temp)
4177 {
4178 appendStringInfoString(es->str, " temp");
4179 if (usage->temp_blks_read > 0)
4180 appendStringInfo(es->str, " read=%" PRId64,
4181 usage->temp_blks_read);
4182 if (usage->temp_blks_written > 0)
4183 appendStringInfo(es->str, " written=%" PRId64,
4184 usage->temp_blks_written);
4185 }
4186 appendStringInfoChar(es->str, '\n');
4187 }
4188
4189 /* As above, show only positive counter values. */
4190 if (has_shared_timing || has_local_timing || has_temp_timing)
4191 {
4192 ExplainIndentText(es);
4193 appendStringInfoString(es->str, "I/O Timings:");
4194
4195 if (has_shared_timing)
4196 {
4197 appendStringInfoString(es->str, " shared");
4198 if (!INSTR_TIME_IS_ZERO(usage->shared_blk_read_time))
4199 appendStringInfo(es->str, " read=%0.3f",
4200 INSTR_TIME_GET_MILLISEC(usage->shared_blk_read_time));
4201 if (!INSTR_TIME_IS_ZERO(usage->shared_blk_write_time))
4202 appendStringInfo(es->str, " write=%0.3f",
4203 INSTR_TIME_GET_MILLISEC(usage->shared_blk_write_time));
4204 if (has_local_timing || has_temp_timing)
4205 appendStringInfoChar(es->str, ',');
4206 }
4207 if (has_local_timing)
4208 {
4209 appendStringInfoString(es->str, " local");
4210 if (!INSTR_TIME_IS_ZERO(usage->local_blk_read_time))
4211 appendStringInfo(es->str, " read=%0.3f",
4212 INSTR_TIME_GET_MILLISEC(usage->local_blk_read_time));
4213 if (!INSTR_TIME_IS_ZERO(usage->local_blk_write_time))
4214 appendStringInfo(es->str, " write=%0.3f",
4215 INSTR_TIME_GET_MILLISEC(usage->local_blk_write_time));
4216 if (has_temp_timing)
4217 appendStringInfoChar(es->str, ',');
4218 }
4219 if (has_temp_timing)
4220 {
4221 appendStringInfoString(es->str, " temp");
4222 if (!INSTR_TIME_IS_ZERO(usage->temp_blk_read_time))
4223 appendStringInfo(es->str, " read=%0.3f",
4224 INSTR_TIME_GET_MILLISEC(usage->temp_blk_read_time));
4225 if (!INSTR_TIME_IS_ZERO(usage->temp_blk_write_time))
4226 appendStringInfo(es->str, " write=%0.3f",
4227 INSTR_TIME_GET_MILLISEC(usage->temp_blk_write_time));
4228 }
4229 appendStringInfoChar(es->str, '\n');
4230 }
4231 }
4232 else
4233 {
4234 ExplainPropertyInteger("Shared Hit Blocks", NULL,
4235 usage->shared_blks_hit, es);
4236 ExplainPropertyInteger("Shared Read Blocks", NULL,
4237 usage->shared_blks_read, es);
4238 ExplainPropertyInteger("Shared Dirtied Blocks", NULL,
4239 usage->shared_blks_dirtied, es);
4240 ExplainPropertyInteger("Shared Written Blocks", NULL,
4241 usage->shared_blks_written, es);
4242 ExplainPropertyInteger("Local Hit Blocks", NULL,
4243 usage->local_blks_hit, es);
4244 ExplainPropertyInteger("Local Read Blocks", NULL,
4245 usage->local_blks_read, es);
4246 ExplainPropertyInteger("Local Dirtied Blocks", NULL,
4247 usage->local_blks_dirtied, es);
4248 ExplainPropertyInteger("Local Written Blocks", NULL,
4249 usage->local_blks_written, es);
4250 ExplainPropertyInteger("Temp Read Blocks", NULL,
4251 usage->temp_blks_read, es);
4252 ExplainPropertyInteger("Temp Written Blocks", NULL,
4253 usage->temp_blks_written, es);
4254 if (track_io_timing)
4255 {
4256 ExplainPropertyFloat("Shared I/O Read Time", "ms",
4257 INSTR_TIME_GET_MILLISEC(usage->shared_blk_read_time),
4258 3, es);
4259 ExplainPropertyFloat("Shared I/O Write Time", "ms",
4260 INSTR_TIME_GET_MILLISEC(usage->shared_blk_write_time),
4261 3, es);
4262 ExplainPropertyFloat("Local I/O Read Time", "ms",
4263 INSTR_TIME_GET_MILLISEC(usage->local_blk_read_time),
4264 3, es);
4265 ExplainPropertyFloat("Local I/O Write Time", "ms",
4266 INSTR_TIME_GET_MILLISEC(usage->local_blk_write_time),
4267 3, es);
4268 ExplainPropertyFloat("Temp I/O Read Time", "ms",
4269 INSTR_TIME_GET_MILLISEC(usage->temp_blk_read_time),
4270 3, es);
4271 ExplainPropertyFloat("Temp I/O Write Time", "ms",
4272 INSTR_TIME_GET_MILLISEC(usage->temp_blk_write_time),
4273 3, es);
4274 }
4275 }
4276}
4277
4278/*
4279 * Show WAL usage details.
4280 */
4281static void
4282show_wal_usage(ExplainState *es, const WalUsage *usage)
4283{
4284 if (es->format == EXPLAIN_FORMAT_TEXT)
4285 {
4286 /* Show only positive counter values. */
4287 if ((usage->wal_records > 0) || (usage->wal_fpi > 0) ||
4288 (usage->wal_bytes > 0) || (usage->wal_buffers_full > 0) ||
4289 (usage->wal_fpi_bytes > 0))
4290 {
4291 ExplainIndentText(es);
4292 appendStringInfoString(es->str, "WAL:");
4293
4294 if (usage->wal_records > 0)
4295 appendStringInfo(es->str, " records=%" PRId64,
4296 usage->wal_records);
4297 if (usage->wal_fpi > 0)
4298 appendStringInfo(es->str, " fpi=%" PRId64,
4299 usage->wal_fpi);
4300 if (usage->wal_bytes > 0)
4301 appendStringInfo(es->str, " bytes=%" PRIu64,
4302 usage->wal_bytes);
4303 if (usage->wal_fpi_bytes > 0)
4304 appendStringInfo(es->str, " fpi bytes=%" PRIu64,
4305 usage->wal_fpi_bytes);
4306 if (usage->wal_buffers_full > 0)
4307 appendStringInfo(es->str, " buffers full=%" PRId64,
4308 usage->wal_buffers_full);
4309 appendStringInfoChar(es->str, '\n');
4310 }
4311 }
4312 else
4313 {
4314 ExplainPropertyInteger("WAL Records", NULL,
4315 usage->wal_records, es);
4316 ExplainPropertyInteger("WAL FPI", NULL,
4317 usage->wal_fpi, es);
4318 ExplainPropertyUInteger("WAL Bytes", NULL,
4319 usage->wal_bytes, es);
4320 ExplainPropertyUInteger("WAL FPI Bytes", NULL,
4321 usage->wal_fpi_bytes, es);
4322 ExplainPropertyInteger("WAL Buffers Full", NULL,
4323 usage->wal_buffers_full, es);
4324 }
4325}
4326
4327/*
4328 * Show memory usage details.
4329 */
4330static void
4331show_memory_counters(ExplainState *es, const MemoryContextCounters *mem_counters)
4332{
4333 int64 memUsedkB = BYTES_TO_KILOBYTES(mem_counters->totalspace -
4334 mem_counters->freespace);
4335 int64 memAllocatedkB = BYTES_TO_KILOBYTES(mem_counters->totalspace);
4336
4337 if (es->format == EXPLAIN_FORMAT_TEXT)
4338 {
4339 ExplainIndentText(es);
4340 appendStringInfo(es->str,
4341 "Memory: used=" INT64_FORMAT "kB allocated=" INT64_FORMAT "kB",
4342 memUsedkB, memAllocatedkB);
4343 appendStringInfoChar(es->str, '\n');
4344 }
4345 else
4346 {
4347 ExplainPropertyInteger("Memory Used", "kB", memUsedkB, es);
4348 ExplainPropertyInteger("Memory Allocated", "kB", memAllocatedkB, es);
4349 }
4350}
4351
4352
4353/*
4354 * Add some additional details about an IndexScan or IndexOnlyScan
4355 */
4356static void
4357ExplainIndexScanDetails(Oid indexid, ScanDirection indexorderdir,
4358 ExplainState *es)
4359{
4360 const char *indexname = explain_get_index_name(indexid);
4361
4362 if (es->format == EXPLAIN_FORMAT_TEXT)
4363 {
4364 if (ScanDirectionIsBackward(indexorderdir))
4365 appendStringInfoString(es->str, " Backward");
4366 appendStringInfo(es->str, " using %s", quote_identifier(indexname));
4367 }
4368 else
4369 {
4370 const char *scandir;
4371
4372 switch (indexorderdir)
4373 {
4374 case BackwardScanDirection:
4375 scandir = "Backward";
4376 break;
4377 case ForwardScanDirection:
4378 scandir = "Forward";
4379 break;
4380 default:
4381 scandir = "???";
4382 break;
4383 }
4384 ExplainPropertyText("Scan Direction", scandir, es);
4385 ExplainPropertyText("Index Name", indexname, es);
4386 }
4387}
4388
4389/*
4390 * Show the target of a Scan node
4391 */
4392static void
4393ExplainScanTarget(Scan *plan, ExplainState *es)
4394{
4395 ExplainTargetRel((Plan *) plan, plan->scanrelid, es);
4396}
4397
4398/*
4399 * Show the target of a ModifyTable node
4400 *
4401 * Here we show the nominal target (ie, the relation that was named in the
4402 * original query). If the actual target(s) is/are different, we'll show them
4403 * in show_modifytable_info().
4404 */
4405static void
4406ExplainModifyTarget(ModifyTable *plan, ExplainState *es)
4407{
4408 ExplainTargetRel((Plan *) plan, plan->nominalRelation, es);
4409}
4410
4411/*
4412 * Show the target relation of a scan or modify node
4413 */
4414static void
4415ExplainTargetRel(Plan *plan, Index rti, ExplainState *es)
4416{
4417 char *objectname = NULL;
4418 char *namespace = NULL;
4419 const char *objecttag = NULL;
4420 RangeTblEntry *rte;
4421 char *refname;
4422
4423 rte = rt_fetch(rti, es->rtable);
4424 refname = (char *) list_nth(es->rtable_names, rti - 1);
4425 if (refname == NULL)
4426 refname = rte->eref->aliasname;
4427
4428 switch (nodeTag(plan))
4429 {
4430 case T_SeqScan:
4431 case T_SampleScan:
4432 case T_IndexScan:
4433 case T_IndexOnlyScan:
4434 case T_BitmapHeapScan:
4435 case T_TidScan:
4436 case T_TidRangeScan:
4437 case T_ForeignScan:
4438 case T_CustomScan:
4439 case T_ModifyTable:
4440 /* Assert it's on a real relation */
4441 Assert(rte->rtekind == RTE_RELATION);
4442 objectname = get_rel_name(rte->relid);
4443 if (es->verbose)
4444 namespace = get_namespace_name_or_temp(get_rel_namespace(rte->relid));
4445 objecttag = "Relation Name";
4446 break;
4447 case T_FunctionScan:
4448 {
4449 FunctionScan *fscan = (FunctionScan *) plan;
4450
4451 /* Assert it's on a RangeFunction */
4452 Assert(rte->rtekind == RTE_FUNCTION);
4453
4454 /*
4455 * If the expression is still a function call of a single
4456 * function, we can get the real name of the function.
4457 * Otherwise, punt. (Even if it was a single function call
4458 * originally, the optimizer could have simplified it away.)
4459 */
4460 if (list_length(fscan->functions) == 1)
4461 {
4462 RangeTblFunction *rtfunc = (RangeTblFunction *) linitial(fscan->functions);
4463
4464 if (IsA(rtfunc->funcexpr, FuncExpr))
4465 {
4466 FuncExpr *funcexpr = (FuncExpr *) rtfunc->funcexpr;
4467 Oid funcid = funcexpr->funcid;
4468
4469 objectname = get_func_name(funcid);
4470 if (es->verbose)
4471 namespace = get_namespace_name_or_temp(get_func_namespace(funcid));
4472 }
4473 }
4474 objecttag = "Function Name";
4475 }
4476 break;
4477 case T_TableFuncScan:
4478 {
4479 TableFunc *tablefunc = ((TableFuncScan *) plan)->tablefunc;
4480
4481 Assert(rte->rtekind == RTE_TABLEFUNC);
4482 switch (tablefunc->functype)
4483 {
4484 case TFT_XMLTABLE:
4485 objectname = "xmltable";
4486 break;
4487 case TFT_JSON_TABLE:
4488 objectname = "json_table";
4489 break;
4490 default:
4491 elog(ERROR, "invalid TableFunc type %d",
4492 (int) tablefunc->functype);
4493 }
4494 objecttag = "Table Function Name";
4495 }
4496 break;
4497 case T_ValuesScan:
4498 Assert(rte->rtekind == RTE_VALUES);
4499 break;
4500 case T_CteScan:
4501 /* Assert it's on a non-self-reference CTE */
4502 Assert(rte->rtekind == RTE_CTE);
4503 Assert(!rte->self_reference);
4504 objectname = rte->ctename;
4505 objecttag = "CTE Name";
4506 break;
4507 case T_NamedTuplestoreScan:
4508 Assert(rte->rtekind == RTE_NAMEDTUPLESTORE);
4509 objectname = rte->enrname;
4510 objecttag = "Tuplestore Name";
4511 break;
4512 case T_WorkTableScan:
4513 /* Assert it's on a self-reference CTE */
4514 Assert(rte->rtekind == RTE_CTE);
4515 Assert(rte->self_reference);
4516 objectname = rte->ctename;
4517 objecttag = "CTE Name";
4518 break;
4519 default:
4520 break;
4521 }
4522
4523 if (es->format == EXPLAIN_FORMAT_TEXT)
4524 {
4525 appendStringInfoString(es->str, " on");
4526 if (namespace != NULL)
4527 appendStringInfo(es->str, " %s.%s", quote_identifier(namespace),
4528 quote_identifier(objectname));
4529 else if (objectname != NULL)
4530 appendStringInfo(es->str, " %s", quote_identifier(objectname));
4531 if (objectname == NULL || strcmp(refname, objectname) != 0)
4532 appendStringInfo(es->str, " %s", quote_identifier(refname));
4533 }
4534 else
4535 {
4536 if (objecttag != NULL && objectname != NULL)
4537 ExplainPropertyText(objecttag, objectname, es);
4538 if (namespace != NULL)
4539 ExplainPropertyText("Schema", namespace, es);
4540 ExplainPropertyText("Alias", refname, es);
4541 }
4542}
4543
4544/*
4545 * Show extra information for a ModifyTable node
4546 *
4547 * We have three objectives here. First, if there's more than one target
4548 * table or it's different from the nominal target, identify the actual
4549 * target(s). Second, give FDWs a chance to display extra info about foreign
4550 * targets. Third, show information about ON CONFLICT.
4551 */
4552static void
4553show_modifytable_info(ModifyTableState *mtstate, List *ancestors,
4554 ExplainState *es)
4555{
4556 ModifyTable *node = (ModifyTable *) mtstate->ps.plan;
4557 const char *operation;
4558 const char *foperation;
4559 bool labeltargets;
4560 int j;
4561 List *idxNames = NIL;
4562 ListCell *lst;
4563
4564 switch (node->operation)
4565 {
4566 case CMD_INSERT:
4567 operation = "Insert";
4568 foperation = "Foreign Insert";
4569 break;
4570 case CMD_UPDATE:
4571 operation = "Update";
4572 foperation = "Foreign Update";
4573 break;
4574 case CMD_DELETE:
4575 operation = "Delete";
4576 foperation = "Foreign Delete";
4577 break;
4578 case CMD_MERGE:
4579 operation = "Merge";
4580 /* XXX unsupported for now, but avoid compiler noise */
4581 foperation = "Foreign Merge";
4582 break;
4583 default:
4584 operation = "???";
4585 foperation = "Foreign ???";
4586 break;
4587 }
4588
4589 /*
4590 * Should we explicitly label target relations?
4591 *
4592 * If there's only one target relation, do not list it if it's the
4593 * relation named in the query, or if it has been pruned. (Normally
4594 * mtstate->resultRelInfo doesn't include pruned relations, but a single
4595 * pruned target relation may be present, if all other target relations
4596 * have been pruned. See ExecInitModifyTable().)
4597 */
4598 labeltargets = (mtstate->mt_nrels > 1 ||
4599 (mtstate->mt_nrels == 1 &&
4600 mtstate->resultRelInfo[0].ri_RangeTableIndex != node->nominalRelation &&
4601 bms_is_member(mtstate->resultRelInfo[0].ri_RangeTableIndex,
4602 mtstate->ps.state->es_unpruned_relids)));
4603
4604 if (labeltargets)
4605 ExplainOpenGroup("Target Tables", "Target Tables", false, es);
4606
4607 for (j = 0; j < mtstate->mt_nrels; j++)
4608 {
4609 ResultRelInfo *resultRelInfo = mtstate->resultRelInfo + j;
4610 FdwRoutine *fdwroutine = resultRelInfo->ri_FdwRoutine;
4611
4612 if (labeltargets)
4613 {
4614 /* Open a group for this target */
4615 ExplainOpenGroup("Target Table", NULL, true, es);
4616
4617 /*
4618 * In text mode, decorate each target with operation type, so that
4619 * ExplainTargetRel's output of " on foo" will read nicely.
4620 */
4621 if (es->format == EXPLAIN_FORMAT_TEXT)
4622 {
4623 ExplainIndentText(es);
4624 appendStringInfoString(es->str,
4625 fdwroutine ? foperation : operation);
4626 }
4627
4628 /* Identify target */
4629 ExplainTargetRel((Plan *) node,
4630 resultRelInfo->ri_RangeTableIndex,
4631 es);
4632
4633 if (es->format == EXPLAIN_FORMAT_TEXT)
4634 {
4635 appendStringInfoChar(es->str, '\n');
4636 es->indent++;
4637 }
4638 }
4639
4640 /* Give FDW a chance if needed */
4641 if (!resultRelInfo->ri_usesFdwDirectModify &&
4642 fdwroutine != NULL &&
4643 fdwroutine->ExplainForeignModify != NULL)
4644 {
4645 List *fdw_private = (List *) list_nth(node->fdwPrivLists, j);
4646
4647 fdwroutine->ExplainForeignModify(mtstate,
4648 resultRelInfo,
4649 fdw_private,
4650 j,
4651 es);
4652 }
4653
4654 if (labeltargets)
4655 {
4656 /* Undo the indentation we added in text format */
4657 if (es->format == EXPLAIN_FORMAT_TEXT)
4658 es->indent--;
4659
4660 /* Close the group */
4661 ExplainCloseGroup("Target Table", NULL, true, es);
4662 }
4663 }
4664
4665 /* Gather names of ON CONFLICT arbiter indexes */
4666 foreach(lst, node->arbiterIndexes)
4667 {
4668 char *indexname = get_rel_name(lfirst_oid(lst));
4669
4670 idxNames = lappend(idxNames, indexname);
4671 }
4672
4673 if (node->onConflictAction != ONCONFLICT_NONE)
4674 {
4675 ExplainPropertyText("Conflict Resolution",
4676 node->onConflictAction == ONCONFLICT_NOTHING ?
4677 "NOTHING" : "UPDATE",
4678 es);
4679
4680 /*
4681 * Don't display arbiter indexes at all when DO NOTHING variant
4682 * implicitly ignores all conflicts
4683 */
4684 if (idxNames)
4685 ExplainPropertyList("Conflict Arbiter Indexes", idxNames, es);
4686
4687 /* ON CONFLICT DO UPDATE WHERE qual is specially displayed */
4688 if (node->onConflictWhere)
4689 {
4690 show_upper_qual((List *) node->onConflictWhere, "Conflict Filter",
4691 &mtstate->ps, ancestors, es);
4692 show_instrumentation_count("Rows Removed by Conflict Filter", 1, &mtstate->ps, es);
4693 }
4694
4695 /* EXPLAIN ANALYZE display of actual outcome for each tuple proposed */
4696 if (es->analyze && mtstate->ps.instrument)
4697 {
4698 double total;
4699 double insert_path;
4700 double other_path;
4701
4702 InstrEndLoop(outerPlanState(mtstate)->instrument);
4703
4704 /* count the number of source rows */
4705 total = outerPlanState(mtstate)->instrument->ntuples;
4706 other_path = mtstate->ps.instrument->ntuples2;
4707 insert_path = total - other_path;
4708
4709 ExplainPropertyFloat("Tuples Inserted", NULL,
4710 insert_path, 0, es);
4711 ExplainPropertyFloat("Conflicting Tuples", NULL,
4712 other_path, 0, es);
4713 }
4714 }
4715 else if (node->operation == CMD_MERGE)
4716 {
4717 /* EXPLAIN ANALYZE display of tuples processed */
4718 if (es->analyze && mtstate->ps.instrument)
4719 {
4720 double total;
4721 double insert_path;
4722 double update_path;
4723 double delete_path;
4724 double skipped_path;
4725
4726 InstrEndLoop(outerPlanState(mtstate)->instrument);
4727
4728 /* count the number of source rows */
4729 total = outerPlanState(mtstate)->instrument->ntuples;
4730 insert_path = mtstate->mt_merge_inserted;
4731 update_path = mtstate->mt_merge_updated;
4732 delete_path = mtstate->mt_merge_deleted;
4733 skipped_path = total - insert_path - update_path - delete_path;
4734 Assert(skipped_path >= 0);
4735
4736 if (es->format == EXPLAIN_FORMAT_TEXT)
4737 {
4738 if (total > 0)
4739 {
4740 ExplainIndentText(es);
4741 appendStringInfoString(es->str, "Tuples:");
4742 if (insert_path > 0)
4743 appendStringInfo(es->str, " inserted=%.0f", insert_path);
4744 if (update_path > 0)
4745 appendStringInfo(es->str, " updated=%.0f", update_path);
4746 if (delete_path > 0)
4747 appendStringInfo(es->str, " deleted=%.0f", delete_path);
4748 if (skipped_path > 0)
4749 appendStringInfo(es->str, " skipped=%.0f", skipped_path);
4750 appendStringInfoChar(es->str, '\n');
4751 }
4752 }
4753 else
4754 {
4755 ExplainPropertyFloat("Tuples Inserted", NULL, insert_path, 0, es);
4756 ExplainPropertyFloat("Tuples Updated", NULL, update_path, 0, es);
4757 ExplainPropertyFloat("Tuples Deleted", NULL, delete_path, 0, es);
4758 ExplainPropertyFloat("Tuples Skipped", NULL, skipped_path, 0, es);
4759 }
4760 }
4761 }
4762
4763 if (labeltargets)
4764 ExplainCloseGroup("Target Tables", "Target Tables", false, es);
4765}
4766
4767/*
4768 * Explain what a "Result" node replaced.
4769 */
4770static void
4771show_result_replacement_info(Result *result, ExplainState *es)
4772{
4773 StringInfoData buf;
4774 int nrels = 0;
4775 int rti = -1;
4776 bool found_non_result = false;
4777 char *replacement_type = "???";
4778
4779 /* If the Result node has a subplan, it didn't replace anything. */
4780 if (result->plan.lefttree != NULL)
4781 return;
4782
4783 /* Gating result nodes should have a subplan, and we don't. */
4784 Assert(result->result_type != RESULT_TYPE_GATING);
4785
4786 switch (result->result_type)
4787 {
4788 case RESULT_TYPE_GATING:
4789 replacement_type = "Gating";
4790 break;
4791 case RESULT_TYPE_SCAN:
4792 replacement_type = "Scan";
4793 break;
4794 case RESULT_TYPE_JOIN:
4795 replacement_type = "Join";
4796 break;
4797 case RESULT_TYPE_UPPER:
4798 /* a small white lie */
4799 replacement_type = "Aggregate";
4800 break;
4801 case RESULT_TYPE_MINMAX:
4802 replacement_type = "MinMaxAggregate";
4803 break;
4804 }
4805
4806 /*
4807 * Build up a comma-separated list of user-facing names for the range
4808 * table entries in the relids set.
4809 */
4810 initStringInfo(&buf);
4811 while ((rti = bms_next_member(result->relids, rti)) >= 0)
4812 {
4813 RangeTblEntry *rte = rt_fetch(rti, es->rtable);
4814 char *refname;
4815
4816 /*
4817 * add_outer_joins_to_relids will add join RTIs to the relids set of a
4818 * join; if that join is then replaced with a Result node, we may see
4819 * such RTIs here. But we want to completely ignore those here,
4820 * because "a LEFT JOIN b ON whatever" is a join between a and b, not
4821 * a join between a, b, and an unnamed join.
4822 */
4823 if (rte->rtekind == RTE_JOIN)
4824 continue;
4825
4826 /* Count the number of rels that aren't ignored completely. */
4827 ++nrels;
4828
4829 /* Work out what reference name to use and add it to the string. */
4830 refname = (char *) list_nth(es->rtable_names, rti - 1);
4831 if (refname == NULL)
4832 refname = rte->eref->aliasname;
4833 if (buf.len > 0)
4834 appendStringInfoString(&buf, ", ");
4835 appendStringInfoString(&buf, refname);
4836
4837 /* Keep track of whether we see anything other than RTE_RESULT. */
4838 if (rte->rtekind != RTE_RESULT)
4839 found_non_result = true;
4840 }
4841
4842 /*
4843 * If this Result node is because of a single RTE that is RTE_RESULT, it
4844 * is not really replacing anything at all, because there's no other
4845 * method for implementing a scan of such an RTE, so we don't display the
4846 * Replaces line in such cases.
4847 */
4848 if (nrels <= 1 && !found_non_result &&
4849 result->result_type == RESULT_TYPE_SCAN)
4850 return;
4851
4852 /* Say what we replaced, with list of rels if available. */
4853 if (buf.len == 0)
4854 ExplainPropertyText("Replaces", replacement_type, es);
4855 else
4856 {
4857 char *s = psprintf("%s on %s", replacement_type, buf.data);
4858
4859 ExplainPropertyText("Replaces", s, es);
4860 }
4861}
4862
4863/*
4864 * Explain the constituent plans of an Append, MergeAppend,
4865 * BitmapAnd, or BitmapOr node.
4866 *
4867 * The ancestors list should already contain the immediate parent of these
4868 * plans.
4869 */
4870static void
4871ExplainMemberNodes(PlanState **planstates, int nplans,
4872 List *ancestors, ExplainState *es)
4873{
4874 int j;
4875
4876 for (j = 0; j < nplans; j++)
4877 ExplainNode(planstates[j], ancestors,
4878 "Member", NULL, es);
4879}
4880
4881/*
4882 * Report about any pruned subnodes of an Append or MergeAppend node.
4883 *
4884 * nplans indicates the number of live subplans.
4885 * nchildren indicates the original number of subnodes in the Plan;
4886 * some of these may have been pruned by the run-time pruning code.
4887 */
4888static void
4889ExplainMissingMembers(int nplans, int nchildren, ExplainState *es)
4890{
4891 if (nplans < nchildren || es->format != EXPLAIN_FORMAT_TEXT)
4892 ExplainPropertyInteger("Subplans Removed", NULL,
4893 nchildren - nplans, es);
4894}
4895
4896/*
4897 * Explain a list of SubPlans (or initPlans, which also use SubPlan nodes).
4898 *
4899 * The ancestors list should already contain the immediate parent of these
4900 * SubPlans.
4901 */
4902static void
4903ExplainSubPlans(List *plans, List *ancestors,
4904 const char *relationship, ExplainState *es)
4905{
4906 ListCell *lst;
4907
4908 foreach(lst, plans)
4909 {
4910 SubPlanState *sps = (SubPlanState *) lfirst(lst);
4911 SubPlan *sp = sps->subplan;
4912 char *cooked_plan_name;
4913
4914 /*
4915 * There can be multiple SubPlan nodes referencing the same physical
4916 * subplan (same plan_id, which is its index in PlannedStmt.subplans).
4917 * We should print a subplan only once, so track which ones we already
4918 * printed. This state must be global across the plan tree, since the
4919 * duplicate nodes could be in different plan nodes, eg both a bitmap
4920 * indexscan's indexqual and its parent heapscan's recheck qual. (We
4921 * do not worry too much about which plan node we show the subplan as
4922 * attached to in such cases.)
4923 */
4924 if (bms_is_member(sp->plan_id, es->printed_subplans))
4925 continue;
4926 es->printed_subplans = bms_add_member(es->printed_subplans,
4927 sp->plan_id);
4928
4929 /*
4930 * Treat the SubPlan node as an ancestor of the plan node(s) within
4931 * it, so that ruleutils.c can find the referents of subplan
4932 * parameters.
4933 */
4934 ancestors = lcons(sp, ancestors);
4935
4936 /*
4937 * The plan has a name like exists_1 or rowcompare_2, but here we want
4938 * to prefix that with CTE, InitPlan, or SubPlan, as appropriate, for
4939 * display purposes.
4940 */
4941 if (sp->subLinkType == CTE_SUBLINK)
4942 cooked_plan_name = psprintf("CTE %s", sp->plan_name);
4943 else if (sp->isInitPlan)
4944 cooked_plan_name = psprintf("InitPlan %s", sp->plan_name);
4945 else
4946 cooked_plan_name = psprintf("SubPlan %s", sp->plan_name);
4947
4948 ExplainNode(sps->planstate, ancestors,
4949 relationship, cooked_plan_name, es);
4950
4951 ancestors = list_delete_first(ancestors);
4952 }
4953}
4954
4955/*
4956 * Explain a list of children of a CustomScan.
4957 */
4958static void
4959ExplainCustomChildren(CustomScanState *css, List *ancestors, ExplainState *es)
4960{
4961 ListCell *cell;
4962 const char *label =
4963 (list_length(css->custom_ps) != 1 ? "children" : "child");
4964
4965 foreach(cell, css->custom_ps)
4966 ExplainNode((PlanState *) lfirst(cell), ancestors, label, NULL, es);
4967}
4968
4969/*
4970 * Create a per-plan-node workspace for collecting per-worker data.
4971 *
4972 * Output related to each worker will be temporarily "set aside" into a
4973 * separate buffer, which we'll merge into the main output stream once
4974 * we've processed all data for the plan node. This makes it feasible to
4975 * generate a coherent sub-group of fields for each worker, even though the
4976 * code that produces the fields is in several different places in this file.
4977 * Formatting of such a set-aside field group is managed by
4978 * ExplainOpenSetAsideGroup and ExplainSaveGroup/ExplainRestoreGroup.
4979 */
4980static ExplainWorkersState *
4981ExplainCreateWorkersState(int num_workers)
4982{
4983 ExplainWorkersState *wstate;
4984
4985 wstate = palloc_object(ExplainWorkersState);
4986 wstate->num_workers = num_workers;
4987 wstate->worker_inited = (bool *) palloc0(num_workers * sizeof(bool));
4988 wstate->worker_str = (StringInfoData *)
4989 palloc0(num_workers * sizeof(StringInfoData));
4990 wstate->worker_state_save = (int *) palloc(num_workers * sizeof(int));
4991 return wstate;
4992}
4993
4994/*
4995 * Begin or resume output into the set-aside group for worker N.
4996 */
4997static void
4998ExplainOpenWorker(int n, ExplainState *es)
4999{
5000 ExplainWorkersState *wstate = es->workers_state;
5001
5002 Assert(wstate);
5003 Assert(n >= 0 && n < wstate->num_workers);
5004
5005 /* Save prior output buffer pointer */
5006 wstate->prev_str = es->str;
5007
5008 if (!wstate->worker_inited[n])
5009 {
5010 /* First time through, so create the buffer for this worker */
5011 initStringInfo(&wstate->worker_str[n]);
5012 es->str = &wstate->worker_str[n];
5013
5014 /*
5015 * Push suitable initial formatting state for this worker's field
5016 * group. We allow one extra logical nesting level, since this group
5017 * will eventually be wrapped in an outer "Workers" group.
5018 */
5019 ExplainOpenSetAsideGroup("Worker", NULL, true, 2, es);
5020
5021 /*
5022 * In non-TEXT formats we always emit a "Worker Number" field, even if
5023 * there's no other data for this worker.
5024 */
5025 if (es->format != EXPLAIN_FORMAT_TEXT)
5026 ExplainPropertyInteger("Worker Number", NULL, n, es);
5027
5028 wstate->worker_inited[n] = true;
5029 }
5030 else
5031 {
5032 /* Resuming output for a worker we've already emitted some data for */
5033 es->str = &wstate->worker_str[n];
5034
5035 /* Restore formatting state saved by last ExplainCloseWorker() */
5036 ExplainRestoreGroup(es, 2, &wstate->worker_state_save[n]);
5037 }
5038
5039 /*
5040 * In TEXT format, prefix the first output line for this worker with
5041 * "Worker N:". Then, any additional lines should be indented one more
5042 * stop than the "Worker N" line is.
5043 */
5044 if (es->format == EXPLAIN_FORMAT_TEXT)
5045 {
5046 if (es->str->len == 0)
5047 {
5048 ExplainIndentText(es);
5049 appendStringInfo(es->str, "Worker %d: ", n);
5050 }
5051
5052 es->indent++;
5053 }
5054}
5055
5056/*
5057 * End output for worker N --- must pair with previous ExplainOpenWorker call
5058 */
5059static void
5060ExplainCloseWorker(int n, ExplainState *es)
5061{
5062 ExplainWorkersState *wstate = es->workers_state;
5063
5064 Assert(wstate);
5065 Assert(n >= 0 && n < wstate->num_workers);
5066 Assert(wstate->worker_inited[n]);
5067
5068 /*
5069 * Save formatting state in case we do another ExplainOpenWorker(), then
5070 * pop the formatting stack.
5071 */
5072 ExplainSaveGroup(es, 2, &wstate->worker_state_save[n]);
5073
5074 /*
5075 * In TEXT format, if we didn't actually produce any output line(s) then
5076 * truncate off the partial line emitted by ExplainOpenWorker. (This is
5077 * to avoid bogus output if, say, show_buffer_usage chooses not to print
5078 * anything for the worker.) Also fix up the indent level.
5079 */
5080 if (es->format == EXPLAIN_FORMAT_TEXT)
5081 {
5082 while (es->str->len > 0 && es->str->data[es->str->len - 1] != '\n')
5083 es->str->data[--(es->str->len)] = '\0';
5084
5085 es->indent--;
5086 }
5087
5088 /* Restore prior output buffer pointer */
5089 es->str = wstate->prev_str;
5090}
5091
5092/*
5093 * Print per-worker info for current node, then free the ExplainWorkersState.
5094 */
5095static void
5096ExplainFlushWorkersState(ExplainState *es)
5097{
5098 ExplainWorkersState *wstate = es->workers_state;
5099
5100 ExplainOpenGroup("Workers", "Workers", false, es);
5101 for (int i = 0; i < wstate->num_workers; i++)
5102 {
5103 if (wstate->worker_inited[i])
5104 {
5105 /* This must match previous ExplainOpenSetAsideGroup call */
5106 ExplainOpenGroup("Worker", NULL, true, es);
5107 appendStringInfoString(es->str, wstate->worker_str[i].data);
5108 ExplainCloseGroup("Worker", NULL, true, es);
5109
5110 pfree(wstate->worker_str[i].data);
5111 }
5112 }
5113 ExplainCloseGroup("Workers", "Workers", false, es);
5114
5115 pfree(wstate->worker_inited);
5116 pfree(wstate->worker_str);
5117 pfree(wstate->worker_state_save);
5118 pfree(wstate);
5119}
AttrNumber
int16 AttrNumber
Definition attnum.h:21
ExplainExecuteQuery
void ExplainExecuteQuery(ExecuteStmt *execstmt, IntoClause *into, ExplainState *es, ParseState *pstate, ParamListInfo params)
Definition prepare.c:571
bms_next_member
int bms_next_member(const Bitmapset *a, int prevbit)
Definition bitmapset.c:1305
bms_is_member
bool bms_is_member(int x, const Bitmapset *a)
Definition bitmapset.c:510
bms_add_member
Bitmapset * bms_add_member(Bitmapset *a, int x)
Definition bitmapset.c:814
bms_add_members
Bitmapset * bms_add_members(Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:916
track_io_timing
bool track_io_timing
Definition bufmgr.c:176
INT64CONST
#define INT64CONST(x)
Definition c.h:560
unconstify
#define unconstify(underlying_type, expr)
Definition c.h:1234
Max
#define Max(x, y)
Definition c.h:991
INT64_FORMAT
#define INT64_FORMAT
Definition c.h:564
Assert
#define Assert(condition)
Definition c.h:873
int64
int64_t int64
Definition c.h:543
UINT64_FORMAT
#define UINT64_FORMAT
Definition c.h:565
uint64
uint64_t uint64
Definition c.h:547
Index
unsigned int Index
Definition c.h:628
OidIsValid
#define OidIsValid(objectId)
Definition c.h:788
CreateTableAsRelExists
bool CreateTableAsRelExists(CreateTableAsStmt *ctas)
Definition createas.c:393
GetIntoRelEFlags
int GetIntoRelEFlags(IntoClause *intoClause)
Definition createas.c:375
CreateIntoRelDestReceiver
DestReceiver * CreateIntoRelDestReceiver(IntoClause *intoClause)
Definition createas.c:440
defGetString
char * defGetString(DefElem *def)
Definition define.c:34
None_Receiver
DestReceiver * None_Receiver
Definition dest.c:96
ERROR
#define ERROR
Definition elog.h:39
elog
#define elog(elevel,...)
Definition elog.h:226
ExecutorEnd
void ExecutorEnd(QueryDesc *queryDesc)
Definition execMain.c:466
ExecutorFinish
void ExecutorFinish(QueryDesc *queryDesc)
Definition execMain.c:406
ExecutorStart
void ExecutorStart(QueryDesc *queryDesc, int eflags)
Definition execMain.c:122
ExecutorRun
void ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count)
Definition execMain.c:297
TTSOpsVirtual
const TupleTableSlotOps TTSOpsVirtual
Definition execTuples.c:84
end_tup_output
void end_tup_output(TupOutputState *tstate)
Definition execTuples.c:2522
do_text_output_multiline
void do_text_output_multiline(TupOutputState *tstate, const char *txt)
Definition execTuples.c:2492
begin_tup_output_tupdesc
TupOutputState * begin_tup_output_tupdesc(DestReceiver *dest, TupleDesc tupdesc, const TupleTableSlotOps *tts_ops)
Definition execTuples.c:2444
outerPlanState
#define outerPlanState(node)
Definition execnodes.h:1263
innerPlanState
#define innerPlanState(node)
Definition execnodes.h:1262
EXEC_FLAG_EXPLAIN_GENERIC
#define EXEC_FLAG_EXPLAIN_GENERIC
Definition executor.h:67
do_text_output_oneline
#define do_text_output_oneline(tstate, str_to_emit)
Definition executor.h:628
EXEC_FLAG_EXPLAIN_ONLY
#define EXEC_FLAG_EXPLAIN_ONLY
Definition executor.h:66
show_modifytable_info
static void show_modifytable_info(ModifyTableState *mtstate, List *ancestors, ExplainState *es)
Definition explain.c:4553
BYTES_TO_KILOBYTES
#define BYTES_TO_KILOBYTES(b)
Definition explain.c:63
show_plan_tlist
static void show_plan_tlist(PlanState *planstate, List *ancestors, ExplainState *es)
Definition explain.c:2446
show_memoize_info
static void show_memoize_info(MemoizeState *mstate, List *ancestors, ExplainState *es)
Definition explain.c:3590
show_group_keys
static void show_group_keys(GroupState *gstate, List *ancestors, ExplainState *es)
Definition explain.c:2756
ExplainModifyTarget
static void ExplainModifyTarget(ModifyTable *plan, ExplainState *es)
Definition explain.c:4406
show_window_def
static void show_window_def(WindowAggState *planstate, List *ancestors, ExplainState *es)
Definition explain.c:2896
show_result_replacement_info
static void show_result_replacement_info(Result *result, ExplainState *es)
Definition explain.c:4771
show_agg_keys
static void show_agg_keys(AggState *astate, List *ancestors, ExplainState *es)
Definition explain.c:2624
show_hashagg_info
static void show_hashagg_info(AggState *aggstate, ExplainState *es)
Definition explain.c:3743
show_scan_qual
static void show_scan_qual(List *qual, const char *qlabel, PlanState *planstate, List *ancestors, ExplainState *es)
Definition explain.c:2548
explain_get_index_name
static const char * explain_get_index_name(Oid indexId)
Definition explain.c:4049
ExplainIndexScanDetails
static void ExplainIndexScanDetails(Oid indexid, ScanDirection indexorderdir, ExplainState *es)
Definition explain.c:4357
ExplainOnePlan
void ExplainOnePlan(PlannedStmt *plannedstmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv, const instr_time *planduration, const BufferUsage *bufusage, const MemoryContextCounters *mem_counters)
Definition explain.c:495
ExplainOneQuery_hook
ExplainOneQuery_hook_type ExplainOneQuery_hook
Definition explain.c:50
show_instrumentation_count
static void show_instrumentation_count(const char *qlabel, int which, PlanState *planstate, ExplainState *es)
Definition explain.c:3992
ExplainNode
static void ExplainNode(PlanState *planstate, List *ancestors, const char *relationship, const char *plan_name, ExplainState *es)
Definition explain.c:1358
show_incremental_sort_group_info
static void show_incremental_sort_group_info(IncrementalSortGroupInfo *groupInfo, const char *groupLabel, bool indent, ExplainState *es)
Definition explain.c:3183
ExplainMemberNodes
static void ExplainMemberNodes(PlanState **planstates, int nplans, List *ancestors, ExplainState *es)
Definition explain.c:4871
show_ctescan_info
static void show_ctescan_info(CteScanState *ctescanstate, ExplainState *es)
Definition explain.c:3521
explain_get_index_name_hook
explain_get_index_name_hook_type explain_get_index_name_hook
Definition explain.c:53
ExplainPreScanNode
static bool ExplainPreScanNode(PlanState *planstate, Bitmapset **rels_used)
Definition explain.c:1185
ExplainPrintJIT
static void ExplainPrintJIT(ExplainState *es, int jit_flags, JitInstrumentation *ji)
Definition explain.c:902
show_recursive_union_info
static void show_recursive_union_info(RecursiveUnionState *rstate, ExplainState *es)
Definition explain.c:3559
ExplainQuery
void ExplainQuery(ParseState *pstate, ExplainStmt *stmt, ParamListInfo params, DestReceiver *dest)
Definition explain.c:177
show_incremental_sort_info
static void show_incremental_sort_info(IncrementalSortState *incrsortstate, ExplainState *es)
Definition explain.c:3297
show_tablesample
static void show_tablesample(TableSampleClause *tsc, PlanState *planstate, List *ancestors, ExplainState *es)
Definition explain.c:3026
show_upper_qual
static void show_upper_qual(List *qual, const char *qlabel, PlanState *planstate, List *ancestors, ExplainState *es)
Definition explain.c:2562
show_sort_info
static void show_sort_info(SortState *sortstate, ExplainState *es)
Definition explain.c:3092
show_window_keys
static void show_window_keys(StringInfo buf, PlanState *planstate, int nkeys, AttrNumber *keycols, List *ancestors, ExplainState *es)
Definition explain.c:2959
ExplainMissingMembers
static void ExplainMissingMembers(int nplans, int nchildren, ExplainState *es)
Definition explain.c:4889
explain_per_node_hook
explain_per_node_hook_type explain_per_node_hook
Definition explain.c:57
ExplainResultDesc
TupleDesc ExplainResultDesc(ExplainStmt *stmt)
Definition explain.c:255
ExplainFlushWorkersState
static void ExplainFlushWorkersState(ExplainState *es)
Definition explain.c:5096
peek_buffer_usage
static bool peek_buffer_usage(ExplainState *es, const BufferUsage *usage)
Definition explain.c:4073
ExplainPrintJITSummary
void ExplainPrintJITSummary(ExplainState *es, QueryDesc *queryDesc)
Definition explain.c:876
show_hash_info
static void show_hash_info(HashState *hashstate, ExplainState *es)
Definition explain.c:3383
show_sortorder_options
static void show_sortorder_options(StringInfo buf, Node *sortexpr, Oid sortOperator, Oid collation, bool nullsFirst)
Definition explain.c:2838
show_table_func_scan_info
static void show_table_func_scan_info(TableFuncScanState *tscanstate, ExplainState *es)
Definition explain.c:3540
show_indexsearches_info
static void show_indexsearches_info(PlanState *planstate, ExplainState *es)
Definition explain.c:3865
show_expression
static void show_expression(Node *node, const char *qlabel, PlanState *planstate, List *ancestors, bool useprefix, ExplainState *es)
Definition explain.c:2504
elapsed_time
static double elapsed_time(instr_time *starttime)
Definition explain.c:1166
ExplainQueryText
void ExplainQueryText(ExplainState *es, QueryDesc *queryDesc)
Definition explain.c:1060
explain_per_plan_hook
explain_per_plan_hook_type explain_per_plan_hook
Definition explain.c:56
plan_is_disabled
static bool plan_is_disabled(Plan *plan)
Definition explain.c:1253
show_sort_group_keys
static void show_sort_group_keys(PlanState *planstate, const char *qlabel, int nkeys, int nPresortedKeys, AttrNumber *keycols, Oid *sortOperators, Oid *collations, bool *nullsFirst, List *ancestors, ExplainState *es)
Definition explain.c:2776
show_tidbitmap_info
static void show_tidbitmap_info(BitmapHeapScanState *planstate, ExplainState *es)
Definition explain.c:3923
show_windowagg_info
static void show_windowagg_info(WindowAggState *winstate, ExplainState *es)
Definition explain.c:3498
show_memory_counters
static void show_memory_counters(ExplainState *es, const MemoryContextCounters *mem_counters)
Definition explain.c:4331
ExplainSubPlans
static void ExplainSubPlans(List *plans, List *ancestors, const char *relationship, ExplainState *es)
Definition explain.c:4903
show_foreignscan_info
static void show_foreignscan_info(ForeignScanState *fsstate, ExplainState *es)
Definition explain.c:4021
ExplainScanTarget
static void ExplainScanTarget(Scan *plan, ExplainState *es)
Definition explain.c:4393
ExplainPrintPlan
void ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc)
Definition explain.c:760
show_merge_append_keys
static void show_merge_append_keys(MergeAppendState *mstate, List *ancestors, ExplainState *es)
Definition explain.c:2608
report_triggers
static void report_triggers(ResultRelInfo *rInfo, bool show_relname, ExplainState *es)
Definition explain.c:1093
ExplainQueryParameters
void ExplainQueryParameters(ExplainState *es, ParamListInfo params, int maxlen)
Definition explain.c:1075
ExplainPrintSerialize
static void ExplainPrintSerialize(ExplainState *es, SerializeMetrics *metrics)
Definition explain.c:1000
show_grouping_sets
static void show_grouping_sets(PlanState *planstate, Agg *agg, List *ancestors, ExplainState *es)
Definition explain.c:2647
ExplainPrintSettings
static void ExplainPrintSettings(ExplainState *es)
Definition explain.c:690
ExplainCloseWorker
static void ExplainCloseWorker(int n, ExplainState *es)
Definition explain.c:5060
ExplainOpenWorker
static void ExplainOpenWorker(int n, ExplainState *es)
Definition explain.c:4998
ExplainOneQuery
static void ExplainOneQuery(Query *query, int cursorOptions, IntoClause *into, ExplainState *es, ParseState *pstate, ParamListInfo params)
Definition explain.c:294
ExplainTargetRel
static void ExplainTargetRel(Plan *plan, Index rti, ExplainState *es)
Definition explain.c:4415
ExplainOneUtility
void ExplainOneUtility(Node *utilityStmt, IntoClause *into, ExplainState *es, ParseState *pstate, ParamListInfo params)
Definition explain.c:391
show_wal_usage
static void show_wal_usage(ExplainState *es, const WalUsage *usage)
Definition explain.c:4282
show_storage_info
static void show_storage_info(char *maxStorageType, int64 maxSpaceUsed, ExplainState *es)
Definition explain.c:3003
show_grouping_set_keys
static void show_grouping_set_keys(PlanState *planstate, Agg *aggnode, Sort *sortnode, List *context, bool useprefix, List *ancestors, ExplainState *es)
Definition explain.c:2678
show_qual
static void show_qual(List *qual, const char *qlabel, PlanState *planstate, List *ancestors, bool useprefix, ExplainState *es)
Definition explain.c:2527
show_material_info
static void show_material_info(MaterialState *mstate, ExplainState *es)
Definition explain.c:3475
show_sort_keys
static void show_sort_keys(SortState *sortstate, List *ancestors, ExplainState *es)
Definition explain.c:2576
ExplainCreateWorkersState
static ExplainWorkersState * ExplainCreateWorkersState(int num_workers)
Definition explain.c:4981
ExplainPrintTriggers
void ExplainPrintTriggers(ExplainState *es, QueryDesc *queryDesc)
Definition explain.c:833
standard_ExplainOneQuery
void standard_ExplainOneQuery(Query *query, int cursorOptions, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
Definition explain.c:319
show_buffer_usage
static void show_buffer_usage(ExplainState *es, const BufferUsage *usage)
Definition explain.c:4113
show_incremental_sort_keys
static void show_incremental_sort_keys(IncrementalSortState *incrsortstate, List *ancestors, ExplainState *es)
Definition explain.c:2591
ExplainCustomChildren
static void ExplainCustomChildren(CustomScanState *css, List *ancestors, ExplainState *es)
Definition explain.c:4959
explain_get_index_name_hook_type
const char *(* explain_get_index_name_hook_type)(Oid indexId)
Definition explain.h:49
explain_per_plan_hook_type
void(* explain_per_plan_hook_type)(PlannedStmt *plannedstmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
Definition explain.h:32
explain_per_node_hook_type
void(* explain_per_node_hook_type)(PlanState *planstate, List *ancestors, const char *relationship, const char *plan_name, ExplainState *es)
Definition explain.h:41
ExplainOneQuery_hook_type
void(* ExplainOneQuery_hook_type)(Query *query, int cursorOptions, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
Definition explain.h:22
GetSerializationMetrics
SerializeMetrics GetSerializationMetrics(DestReceiver *dest)
Definition explain_dr.c:300
CreateExplainSerializeDestReceiver
DestReceiver * CreateExplainSerializeDestReceiver(ExplainState *es)
Definition explain_dr.c:275
explain_dr.h
ExplainPropertyText
void ExplainPropertyText(const char *qlabel, const char *value, ExplainState *es)
Definition explain_format.c:214
ExplainOpenGroup
void ExplainOpenGroup(const char *objtype, const char *labelname, bool labeled, ExplainState *es)
Definition explain_format.c:279
ExplainPropertyUInteger
void ExplainPropertyUInteger(const char *qlabel, const char *unit, uint64 value, ExplainState *es)
Definition explain_format.c:236
ExplainPropertyInteger
void ExplainPropertyInteger(const char *qlabel, const char *unit, int64 value, ExplainState *es)
Definition explain_format.c:223
ExplainPropertyListNested
void ExplainPropertyListNested(const char *qlabel, List *data, ExplainState *es)
Definition explain_format.c:108
ExplainOpenSetAsideGroup
void ExplainOpenSetAsideGroup(const char *objtype, const char *labelname, bool labeled, int depth, ExplainState *es)
Definition explain_format.c:389
ExplainDummyGroup
void ExplainDummyGroup(const char *objtype, const char *labelname, ExplainState *es)
Definition explain_format.c:489
ExplainSeparatePlans
void ExplainSeparatePlans(ExplainState *es)
Definition explain_format.c:595
ExplainEndOutput
void ExplainEndOutput(ExplainState *es)
Definition explain_format.c:566
ExplainIndentText
void ExplainIndentText(ExplainState *es)
Definition explain_format.c:651
ExplainPropertyFloat
void ExplainPropertyFloat(const char *qlabel, const char *unit, double value, int ndigits, ExplainState *es)
Definition explain_format.c:250
ExplainCloseGroup
void ExplainCloseGroup(const char *objtype, const char *labelname, bool labeled, ExplainState *es)
Definition explain_format.c:342
ExplainBeginOutput
void ExplainBeginOutput(ExplainState *es)
Definition explain_format.c:535
ExplainPropertyBool
void ExplainPropertyBool(const char *qlabel, bool value, ExplainState *es)
Definition explain_format.c:264
ExplainRestoreGroup
void ExplainRestoreGroup(ExplainState *es, int depth, int *state_save)
Definition explain_format.c:458
ExplainSaveGroup
void ExplainSaveGroup(ExplainState *es, int depth, int *state_save)
Definition explain_format.c:428
ExplainPropertyList
void ExplainPropertyList(const char *qlabel, List *data, ExplainState *es)
Definition explain_format.c:38
explain_format.h
NewExplainState
ExplainState * NewExplainState(void)
Definition explain_state.c:61
ParseExplainOptionList
void ParseExplainOptionList(ExplainState *es, List *options, ParseState *pstate)
Definition explain_state.c:77
explain_state.h
EXPLAIN_SERIALIZE_TEXT
@ EXPLAIN_SERIALIZE_TEXT
Definition explain_state.h:23
EXPLAIN_SERIALIZE_NONE
@ EXPLAIN_SERIALIZE_NONE
Definition explain_state.h:22
EXPLAIN_SERIALIZE_BINARY
@ EXPLAIN_SERIALIZE_BINARY
Definition explain_state.h:24
EXPLAIN_FORMAT_TEXT
@ EXPLAIN_FORMAT_TEXT
Definition explain_state.h:29
palloc_object
#define palloc_object(type)
Definition fe_memutils.h:74
GetConfigOptionByName
char * GetConfigOptionByName(const char *name, const char **varname, bool missing_ok)
Definition guc.c:5301
get_explain_guc_options
struct config_generic ** get_explain_guc_options(int *num)
Definition guc.c:5200
guc_tables.h
str
const char * str
Definition hashfn_unstable.h:261
stmt
#define stmt
Definition indent_codes.h:59
ps
struct parser_state ps
INSTR_TIME_SET_CURRENT
#define INSTR_TIME_SET_CURRENT(t)
Definition instr_time.h:122
INSTR_TIME_ADD
#define INSTR_TIME_ADD(x, y)
Definition instr_time.h:178
INSTR_TIME_IS_ZERO
#define INSTR_TIME_IS_ZERO(t)
Definition instr_time.h:169
INSTR_TIME_GET_DOUBLE
#define INSTR_TIME_GET_DOUBLE(t)
Definition instr_time.h:190
INSTR_TIME_SUBTRACT
#define INSTR_TIME_SUBTRACT(x, y)
Definition instr_time.h:181
INSTR_TIME_GET_MILLISEC
#define INSTR_TIME_GET_MILLISEC(t)
Definition instr_time.h:193
INSTR_TIME_SET_ZERO
#define INSTR_TIME_SET_ZERO(t)
Definition instr_time.h:172
InstrEndLoop
void InstrEndLoop(Instrumentation *instr)
Definition instrument.c:140
pgBufferUsage
BufferUsage pgBufferUsage
Definition instrument.c:20
BufferUsageAccumDiff
void BufferUsageAccumDiff(BufferUsage *dst, const BufferUsage *add, const BufferUsage *sub)
Definition instrument.c:245
INSTRUMENT_TIMER
@ INSTRUMENT_TIMER
Definition instrument.h:63
INSTRUMENT_BUFFERS
@ INSTRUMENT_BUFFERS
Definition instrument.h:64
INSTRUMENT_WAL
@ INSTRUMENT_WAL
Definition instrument.h:66
INSTRUMENT_ROWS
@ INSTRUMENT_ROWS
Definition instrument.h:65
NUM_TUPLESORTMETHODS
#define NUM_TUPLESORTMETHODS
Definition instrument_node.h:142
SORT_SPACE_TYPE_DISK
@ SORT_SPACE_TYPE_DISK
Definition instrument_node.h:122
SORT_SPACE_TYPE_MEMORY
@ SORT_SPACE_TYPE_MEMORY
Definition instrument_node.h:123
TuplesortMethod
TuplesortMethod
Definition instrument_node.h:135
SORT_TYPE_STILL_IN_PROGRESS
@ SORT_TYPE_STILL_IN_PROGRESS
Definition instrument_node.h:136
j
int j
Definition isn.c:78
i
int i
Definition isn.c:77
InstrJitAgg
void InstrJitAgg(JitInstrumentation *dst, JitInstrumentation *add)
Definition jit.c:182
PGJIT_OPT3
#define PGJIT_OPT3
Definition jit.h:21
PGJIT_EXPR
#define PGJIT_EXPR
Definition jit.h:23
PGJIT_DEFORM
#define PGJIT_DEFORM
Definition jit.h:24
PGJIT_INLINE
#define PGJIT_INLINE
Definition jit.h:22
PGJIT_PERFORM
#define PGJIT_PERFORM
Definition jit.h:20
lappend
List * lappend(List *list, void *datum)
Definition list.c:339
list_delete_first
List * list_delete_first(List *list)
Definition list.c:943
lcons
List * lcons(void *datum, List *list)
Definition list.c:495
get_rel_name
char * get_rel_name(Oid relid)
Definition lsyscache.c:2078
get_opname
char * get_opname(Oid opno)
Definition lsyscache.c:1460
get_equality_op_for_ordering_op
Oid get_equality_op_for_ordering_op(Oid opno, bool *reverse)
Definition lsyscache.c:324
get_rel_namespace
Oid get_rel_namespace(Oid relid)
Definition lsyscache.c:2102
get_typcollation
Oid get_typcollation(Oid typid)
Definition lsyscache.c:3206
get_collation_name
char * get_collation_name(Oid colloid)
Definition lsyscache.c:1111
get_namespace_name_or_temp
char * get_namespace_name_or_temp(Oid nspid)
Definition lsyscache.c:3540
get_constraint_name
char * get_constraint_name(Oid conoid)
Definition lsyscache.c:1157
get_func_name
char * get_func_name(Oid funcid)
Definition lsyscache.c:1758
get_func_namespace
Oid get_func_namespace(Oid funcid)
Definition lsyscache.c:1782
make_orclause
Expr * make_orclause(List *orclauses)
Definition makefuncs.c:743
make_ands_explicit
Expr * make_ands_explicit(List *andclauses)
Definition makefuncs.c:799
make_andclause
Expr * make_andclause(List *andclauses)
Definition makefuncs.c:727
MemoryContextMemConsumed
void MemoryContextMemConsumed(MemoryContext context, MemoryContextCounters *consumed)
Definition mcxt.c:835
pstrdup
char * pstrdup(const char *in)
Definition mcxt.c:1781
pfree
void pfree(void *pointer)
Definition mcxt.c:1616
palloc0
void * palloc0(Size size)
Definition mcxt.c:1417
palloc
void * palloc(Size size)
Definition mcxt.c:1387
CurrentMemoryContext
MemoryContext CurrentMemoryContext
Definition mcxt.c:160
AllocSetContextCreate
#define AllocSetContextCreate
Definition memutils.h:129
ALLOCSET_DEFAULT_SIZES
#define ALLOCSET_DEFAULT_SIZES
Definition memutils.h:160
exprType
Oid exprType(const Node *expr)
Definition nodeFuncs.c:42
planstate_tree_walker
#define planstate_tree_walker(ps, w, c)
Definition nodeFuncs.h:179
SETOPCMD_EXCEPT
@ SETOPCMD_EXCEPT
Definition nodes.h:410
SETOPCMD_EXCEPT_ALL
@ SETOPCMD_EXCEPT_ALL
Definition nodes.h:411
SETOPCMD_INTERSECT_ALL
@ SETOPCMD_INTERSECT_ALL
Definition nodes.h:409
SETOPCMD_INTERSECT
@ SETOPCMD_INTERSECT
Definition nodes.h:408
SETOP_HASHED
@ SETOP_HASHED
Definition nodes.h:417
SETOP_SORTED
@ SETOP_SORTED
Definition nodes.h:416
DO_AGGSPLIT_SKIPFINAL
#define DO_AGGSPLIT_SKIPFINAL(as)
Definition nodes.h:396
IsA
#define IsA(nodeptr, _type_)
Definition nodes.h:164
copyObject
#define copyObject(obj)
Definition nodes.h:232
nodeTag
#define nodeTag(nodeptr)
Definition nodes.h:139
DO_AGGSPLIT_COMBINE
#define DO_AGGSPLIT_COMBINE(as)
Definition nodes.h:395
ONCONFLICT_NONE
@ ONCONFLICT_NONE
Definition nodes.h:428
ONCONFLICT_NOTHING
@ ONCONFLICT_NOTHING
Definition nodes.h:429
CMD_MERGE
@ CMD_MERGE
Definition nodes.h:279
CMD_UTILITY
@ CMD_UTILITY
Definition nodes.h:280
CMD_INSERT
@ CMD_INSERT
Definition nodes.h:277
CMD_DELETE
@ CMD_DELETE
Definition nodes.h:278
CMD_UPDATE
@ CMD_UPDATE
Definition nodes.h:276
CMD_SELECT
@ CMD_SELECT
Definition nodes.h:275
AGG_SORTED
@ AGG_SORTED
Definition nodes.h:365
AGG_HASHED
@ AGG_HASHED
Definition nodes.h:366
AGG_MIXED
@ AGG_MIXED
Definition nodes.h:367
AGG_PLAIN
@ AGG_PLAIN
Definition nodes.h:364
castNode
#define castNode(_type_, nodeptr)
Definition nodes.h:182
JOIN_SEMI
@ JOIN_SEMI
Definition nodes.h:317
JOIN_FULL
@ JOIN_FULL
Definition nodes.h:305
JOIN_INNER
@ JOIN_INNER
Definition nodes.h:303
JOIN_RIGHT
@ JOIN_RIGHT
Definition nodes.h:306
JOIN_RIGHT_SEMI
@ JOIN_RIGHT_SEMI
Definition nodes.h:319
JOIN_LEFT
@ JOIN_LEFT
Definition nodes.h:304
JOIN_RIGHT_ANTI
@ JOIN_RIGHT_ANTI
Definition nodes.h:320
JOIN_ANTI
@ JOIN_ANTI
Definition nodes.h:318
MemoryContextSwitchTo
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition palloc.h:124
BuildParamLogString
char * BuildParamLogString(ParamListInfo params, char **knownTextValues, int maxlen)
Definition params.c:333
get_tle_by_resno
TargetEntry * get_tle_by_resno(List *tlist, AttrNumber resno)
Definition parse_relation.c:3541
RTE_JOIN
@ RTE_JOIN
Definition parsenodes.h:1072
RTE_CTE
@ RTE_CTE
Definition parsenodes.h:1076
RTE_NAMEDTUPLESTORE
@ RTE_NAMEDTUPLESTORE
Definition parsenodes.h:1077
RTE_VALUES
@ RTE_VALUES
Definition parsenodes.h:1075
RTE_RESULT
@ RTE_RESULT
Definition parsenodes.h:1078
RTE_FUNCTION
@ RTE_FUNCTION
Definition parsenodes.h:1073
RTE_TABLEFUNC
@ RTE_TABLEFUNC
Definition parsenodes.h:1074
RTE_GROUP
@ RTE_GROUP
Definition parsenodes.h:1081
RTE_RELATION
@ RTE_RELATION
Definition parsenodes.h:1070
OBJECT_MATVIEW
@ OBJECT_MATVIEW
Definition parsenodes.h:2375
OBJECT_TABLE
@ OBJECT_TABLE
Definition parsenodes.h:2393
CURSOR_OPT_PARALLEL_OK
#define CURSOR_OPT_PARALLEL_OK
Definition parsenodes.h:3425
FRAMEOPTION_NONDEFAULT
#define FRAMEOPTION_NONDEFAULT
Definition parsenodes.h:609
post_parse_analyze_hook
post_parse_analyze_hook_type post_parse_analyze_hook
Definition analyze.c:68
rt_fetch
#define rt_fetch(rangetable_index, rangetable)
Definition parsetree.h:31
usage
static void usage(void)
Definition pg_archivecleanup.c:258
arg
void * arg
Definition pg_backup_utils.c:29
format
static char format
Definition pg_basebackup.c:134
label
static char * label
Definition pg_basebackup.c:135
relname
NameData relname
Definition pg_class.h:38
lfirst
#define lfirst(lc)
Definition pg_list.h:172
lfirst_node
#define lfirst_node(type, lc)
Definition pg_list.h:176
list_length
static int list_length(const List *l)
Definition pg_list.h:152
linitial_node
#define linitial_node(type, l)
Definition pg_list.h:181
NIL
#define NIL
Definition pg_list.h:68
foreach_current_index
#define foreach_current_index(var_or_cell)
Definition pg_list.h:403
lfirst_int
#define lfirst_int(lc)
Definition pg_list.h:173
list_make1
#define list_make1(x1)
Definition pg_list.h:212
linitial_int
#define linitial_int(l)
Definition pg_list.h:179
list_nth
static void * list_nth(const List *list, int n)
Definition pg_list.h:299
linitial
#define linitial(l)
Definition pg_list.h:178
lnext
static ListCell * lnext(const List *l, const ListCell *c)
Definition pg_list.h:343
lfirst_oid
#define lfirst_oid(lc)
Definition pg_list.h:174
plan
#define plan(x)
Definition pg_regress.c:161
buf
static char buf[DEFAULT_XLOG_SEG_SIZE]
Definition pg_test_fsync.c:71
pg_type.h
innerPlan
#define innerPlan(node)
Definition plannodes.h:260
outerPlan
#define outerPlan(node)
Definition plannodes.h:261
RESULT_TYPE_UPPER
@ RESULT_TYPE_UPPER
Definition plannodes.h:274
RESULT_TYPE_SCAN
@ RESULT_TYPE_SCAN
Definition plannodes.h:272
RESULT_TYPE_GATING
@ RESULT_TYPE_GATING
Definition plannodes.h:271
RESULT_TYPE_MINMAX
@ RESULT_TYPE_MINMAX
Definition plannodes.h:275
RESULT_TYPE_JOIN
@ RESULT_TYPE_JOIN
Definition plannodes.h:273
pg_plan_query
PlannedStmt * pg_plan_query(Query *querytree, const char *query_string, int cursorOptions, ParamListInfo boundParams, ExplainState *es)
Definition postgres.c:887
Oid
unsigned int Oid
Definition postgres_ext.h:32
FreeQueryDesc
void FreeQueryDesc(QueryDesc *qdesc)
Definition pquery.c:106
CreateQueryDesc
QueryDesc * CreateQueryDesc(PlannedStmt *plannedstmt, const char *sourceText, Snapshot snapshot, Snapshot crosscheck_snapshot, DestReceiver *dest, ParamListInfo params, QueryEnvironment *queryEnv, int instrument_options)
Definition pquery.c:68
fb
static int fb(int x)
Definition preproc-init.c:92
CTE_SUBLINK
@ CTE_SUBLINK
Definition primnodes.h:1036
TFT_XMLTABLE
@ TFT_XMLTABLE
Definition primnodes.h:100
TFT_JSON_TABLE
@ TFT_JSON_TABLE
Definition primnodes.h:101
psprintf
char * psprintf(const char *fmt,...)
Definition psprintf.c:43
COMPUTE_QUERY_ID_REGRESS
@ COMPUTE_QUERY_ID_REGRESS
Definition queryjumble.h:86
IsQueryIdEnabled
static bool IsQueryIdEnabled(void)
Definition queryjumble.h:104
JumbleQuery
JumbleState * JumbleQuery(Query *query)
Definition queryjumblefuncs.c:137
compute_query_id
int compute_query_id
Definition queryjumblefuncs.c:52
functions
static const struct fns functions
Definition regcomp.c:358
RelationGetRelationName
#define RelationGetRelationName(relation)
Definition rel.h:548
QueryRewrite
List * QueryRewrite(Query *parsetree)
Definition rewriteHandler.c:4567
deparse_context_for_plan_tree
List * deparse_context_for_plan_tree(PlannedStmt *pstmt, List *rtable_names)
Definition ruleutils.c:3756
set_deparse_context_plan
List * set_deparse_context_plan(List *dpcontext, Plan *plan, List *ancestors)
Definition ruleutils.c:3828
quote_identifier
const char * quote_identifier(const char *ident)
Definition ruleutils.c:13060
select_rtable_names_for_explain
List * select_rtable_names_for_explain(List *rtable, Bitmapset *rels_used)
Definition ruleutils.c:3858
get_window_frame_options_for_explain
char * get_window_frame_options_for_explain(int frameOptions, Node *startOffset, Node *endOffset, List *dpcontext, bool forceprefix)
Definition ruleutils.c:6912
deparse_expression
char * deparse_expression(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit)
Definition ruleutils.c:3648
ScanDirectionIsBackward
#define ScanDirectionIsBackward(direction)
Definition sdir.h:50
ScanDirection
ScanDirection
Definition sdir.h:25
NoMovementScanDirection
@ NoMovementScanDirection
Definition sdir.h:27
BackwardScanDirection
@ BackwardScanDirection
Definition sdir.h:26
ForwardScanDirection
@ ForwardScanDirection
Definition sdir.h:28
UpdateActiveSnapshotCommandId
void UpdateActiveSnapshotCommandId(void)
Definition snapmgr.c:744
PopActiveSnapshot
void PopActiveSnapshot(void)
Definition snapmgr.c:775
PushCopiedSnapshot
void PushCopiedSnapshot(Snapshot snapshot)
Definition snapmgr.c:732
GetActiveSnapshot
Snapshot GetActiveSnapshot(void)
Definition snapmgr.c:800
InvalidSnapshot
#define InvalidSnapshot
Definition snapshot.h:119
resetStringInfo
void resetStringInfo(StringInfo str)
Definition stringinfo.c:126
appendStringInfo
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition stringinfo.c:145
appendStringInfoSpaces
void appendStringInfoSpaces(StringInfo str, int count)
Definition stringinfo.c:260
appendStringInfoString
void appendStringInfoString(StringInfo str, const char *s)
Definition stringinfo.c:230
appendStringInfoChar
void appendStringInfoChar(StringInfo str, char ch)
Definition stringinfo.c:242
initStringInfo
void initStringInfo(StringInfo str)
Definition stringinfo.c:97
AggState::ss
ScanState ss
Definition execnodes.h:2420
Agg::groupingSets
List * groupingSets
Definition plannodes.h:1220
Agg::plan
Plan plan
Definition plannodes.h:1190
Agg::aggstrategy
AggStrategy aggstrategy
Definition plannodes.h:1193
BitmapHeapScanState::pstate
ParallelBitmapHeapState * pstate
Definition execnodes.h:1876
BitmapHeapScanState::stats
BitmapHeapScanInstrumentation stats
Definition execnodes.h:1874
BitmapHeapScanState::sinstrument
SharedBitmapHeapInstrumentation * sinstrument
Definition execnodes.h:1877
BitmapIndexScanState::biss_Instrument
IndexScanInstrumentation biss_Instrument
Definition execnodes.h:1817
CustomScan::custom_plans
List * custom_plans
Definition plannodes.h:917
DefElem::defname
char * defname
Definition parsenodes.h:844
EState::es_tuple_routing_result_relations
List * es_tuple_routing_result_relations
Definition execnodes.h:700
EState::es_jit
struct JitContext * es_jit
Definition execnodes.h:766
EState::es_jit_worker_instr
struct JitInstrumentation * es_jit_worker_instr
Definition execnodes.h:767
EState::es_unpruned_relids
Bitmapset * es_unpruned_relids
Definition execnodes.h:675
EState::es_trig_target_relations
List * es_trig_target_relations
Definition execnodes.h:703
EState::es_jit_flags
int es_jit_flags
Definition execnodes.h:765
EState::es_opened_result_relations
List * es_opened_result_relations
Definition execnodes.h:690
ExplainState::printed_subplans
Bitmapset * printed_subplans
Definition explain_state.h:68
ExplainState::rtable_names
List * rtable_names
Definition explain_state.h:66
ExplainState::workers_state
ExplainWorkersState * workers_state
Definition explain_state.h:73
ExplainState::str
StringInfo str
Definition explain_state.h:46
ExplainState::format
ExplainFormat format
Definition explain_state.h:59
ExplainState::pstmt
PlannedStmt * pstmt
Definition explain_state.h:64
ExplainState::serialize
ExplainSerializeOption serialize
Definition explain_state.h:58
ExplainState::deparse_cxt
List * deparse_cxt
Definition explain_state.h:67
FdwRoutine::ExplainForeignScan
ExplainForeignScan_function ExplainForeignScan
Definition fdwapi.h:252
FdwRoutine::ExplainForeignModify
ExplainForeignModify_function ExplainForeignModify
Definition fdwapi.h:253
FdwRoutine::ExplainDirectModify
ExplainDirectModify_function ExplainDirectModify
Definition fdwapi.h:254
ForeignScanState::fdwroutine
struct FdwRoutine * fdwroutine
Definition execnodes.h:2093
FuncExpr::funcid
Oid funcid
Definition primnodes.h:782
Group::plan
Plan plan
Definition plannodes.h:1161
IncrementalSortInfo::prefixsortGroupInfo
IncrementalSortGroupInfo prefixsortGroupInfo
Definition instrument_node.h:201
IncrementalSortInfo::fullsortGroupInfo
IncrementalSortGroupInfo fullsortGroupInfo
Definition instrument_node.h:200
IndexOnlyScanState::ioss_Instrument
IndexScanInstrumentation ioss_Instrument
Definition execnodes.h:1776
IndexScanState::iss_Instrument
IndexScanInstrumentation iss_Instrument
Definition execnodes.h:1725
Instrumentation::nfiltered2
double nfiltered2
Definition instrument.h:92
Instrumentation::nfiltered1
double nfiltered1
Definition instrument.h:91
Instrumentation::walusage
WalUsage walusage
Definition instrument.h:94
Instrumentation::total
instr_time total
Definition instrument.h:87
Instrumentation::bufusage
BufferUsage bufusage
Definition instrument.h:93
Instrumentation::startup
instr_time startup
Definition instrument.h:86
IntoClause::skipData
bool skipData
Definition primnodes.h:171
JitContext::instr
JitInstrumentation instr
Definition jit.h:62
List
Definition pg_list.h:54
ModifyTableState::resultRelInfo
ResultRelInfo * resultRelInfo
Definition execnodes.h:1410
ModifyTableState::mt_merge_deleted
double mt_merge_deleted
Definition execnodes.h:1465
ModifyTableState::mt_merge_inserted
double mt_merge_inserted
Definition execnodes.h:1463
ModifyTableState::mt_merge_updated
double mt_merge_updated
Definition execnodes.h:1464
ModifyTable::nominalRelation
Index nominalRelation
Definition plannodes.h:338
ModifyTable::arbiterIndexes
List * arbiterIndexes
Definition plannodes.h:364
ModifyTable::operation
CmdType operation
Definition plannodes.h:334
ModifyTable::fdwPrivLists
List * fdwPrivLists
Definition plannodes.h:354
ModifyTable::onConflictWhere
Node * onConflictWhere
Definition plannodes.h:370
ModifyTable::onConflictAction
OnConflictAction onConflictAction
Definition plannodes.h:362
Node
Definition nodes.h:135
ParseState::p_queryEnv
QueryEnvironment * p_queryEnv
Definition parse_node.h:223
ParseState::p_sourcetext
const char * p_sourcetext
Definition parse_node.h:195
PlanState::worker_jit_instrument
struct SharedJitInstrumentation * worker_jit_instrument
Definition execnodes.h:1181
PlanState::instrument
Instrumentation * instrument
Definition execnodes.h:1177
PlanState::plan
Plan * plan
Definition execnodes.h:1167
PlanState::subPlan
List * subPlan
Definition execnodes.h:1194
PlanState::state
EState * state
Definition execnodes.h:1169
PlanState::worker_instrument
WorkerInstrumentation * worker_instrument
Definition execnodes.h:1178
PlanState::initPlan
List * initPlan
Definition execnodes.h:1192
Plan::lefttree
struct Plan * lefttree
Definition plannodes.h:233
Plan::disabled_nodes
int disabled_nodes
Definition plannodes.h:195
PlannedStmt::queryId
int64 queryId
Definition plannodes.h:71
PlannedStmt::commandType
CmdType commandType
Definition plannodes.h:68
PlannedStmt::rtable
List * rtable
Definition plannodes.h:109
QueryDesc::sourceText
const char * sourceText
Definition execdesc.h:38
QueryDesc::estate
EState * estate
Definition execdesc.h:48
QueryDesc::plannedstmt
PlannedStmt * plannedstmt
Definition execdesc.h:37
QueryDesc::planstate
PlanState * planstate
Definition execdesc.h:49
Query::commandType
CmdType commandType
Definition parsenodes.h:121
Query::utilityStmt
Node * utilityStmt
Definition parsenodes.h:141
RecursiveUnionState::working_table
Tuplestorestate * working_table
Definition execnodes.h:1570
RecursiveUnionState::intermediate_table
Tuplestorestate * intermediate_table
Definition execnodes.h:1571
ResultRelInfo::ri_RangeTableIndex
Index ri_RangeTableIndex
Definition execnodes.h:479
ResultRelInfo::ri_FdwRoutine
struct FdwRoutine * ri_FdwRoutine
Definition execnodes.h:535
ResultRelInfo::ri_usesFdwDirectModify
bool ri_usesFdwDirectModify
Definition execnodes.h:541
Result::result_type
ResultType result_type
Definition plannodes.h:298
Result::relids
Bitmapset * relids
Definition plannodes.h:300
Result::plan
Plan plan
Definition plannodes.h:297
ScanState::ps
PlanState ps
Definition execnodes.h:1623
SerializeMetrics::timeSpent
instr_time timeSpent
Definition explain_dr.h:26
SerializeMetrics::bufferUsage
BufferUsage bufferUsage
Definition explain_dr.h:27
SharedBitmapHeapInstrumentation::sinstrument
BitmapHeapScanInstrumentation sinstrument[FLEXIBLE_ARRAY_MEMBER]
Definition instrument_node.h:82
SharedHashInfo::hinstrument
HashInstrumentation hinstrument[FLEXIBLE_ARRAY_MEMBER]
Definition instrument_node.h:180
SharedJitInstrumentation::jit_instr
JitInstrumentation jit_instr[FLEXIBLE_ARRAY_MEMBER]
Definition jit.h:54
SharedSortInfo::sinstrument
TuplesortInstrumentation sinstrument[FLEXIBLE_ARRAY_MEMBER]
Definition instrument_node.h:157
SortState::sort_Done
bool sort_Done
Definition execnodes.h:2348
SortState::tuplesortstate
void * tuplesortstate
Definition execnodes.h:2351
SortState::shared_info
SharedSortInfo * shared_info
Definition execnodes.h:2354
SortState::ss
ScanState ss
Definition execnodes.h:2344
Sort::numCols
int numCols
Definition plannodes.h:1127
TableFunc::functype
TableFuncType functype
Definition primnodes.h:114
TargetEntry::expr
Expr * expr
Definition primnodes.h:2239
TuplesortInstrumentation::spaceType
TuplesortSpaceType spaceType
Definition instrument_node.h:147
WindowAggState::ss
ScanState ss
Definition execnodes.h:2517
WindowAggState::buffer
Tuplestorestate * buffer
Definition execnodes.h:2528
WorkerInstrumentation::instrument
Instrumentation instrument[FLEXIBLE_ARRAY_MEMBER]
Definition instrument.h:100
_DestReceiver
Definition dest.h:116
config_generic
Definition guc_tables.h:250
config_generic::context
GucContext context
Definition guc_tables.h:253
instr_time
Definition instr_time.h:70
CreateTemplateTupleDesc
TupleDesc CreateTemplateTupleDesc(int natts)
Definition tupdesc.c:182
TupleDescInitEntry
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition tupdesc.c:842
tuplesort_get_stats
void tuplesort_get_stats(Tuplesortstate *state, TuplesortInstrumentation *stats)
Definition tuplesort.c:2484
tuplesort_space_type_name
const char * tuplesort_space_type_name(TuplesortSpaceType t)
Definition tuplesort.c:2551
tuplesort_method_name
const char * tuplesort_method_name(TuplesortMethod m)
Definition tuplesort.c:2528
tuplestore_get_stats
void tuplestore_get_stats(Tuplestorestate *state, char **max_storage_type, int64 *max_space)
Definition tuplestore.c:1533
lookup_type_cache
TypeCacheEntry * lookup_type_cache(Oid type_id, int flags)
Definition typcache.c:386
TYPECACHE_GT_OPR
#define TYPECACHE_GT_OPR
Definition typcache.h:140
TYPECACHE_LT_OPR
#define TYPECACHE_LT_OPR
Definition typcache.h:139
bit
Datum bit(PG_FUNCTION_ARGS)
Definition varbit.c:391
CommandCounterIncrement
void CommandCounterIncrement(void)
Definition xact.c:1101