projects / postgresql.git / commitdiff
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 6aa4406)
Add memory/disk usage for more executor nodes.
authorTatsuo Ishii <ishii@postgresql.org>
Mon, 23 Sep 2024 07:34:24 +0000 (16:34 +0900)
committerTatsuo Ishii <ishii@postgresql.org>
Mon, 23 Sep 2024 07:34:24 +0000 (16:34 +0900)
This commit is similar to 95d6e9af07, expanding the idea to CTE scan,
table function scan and recursive union scan nodes so that the maximum
tuplestore memory or disk usage is shown with EXPLAIN ANALYZE command.

Also adjust show_storage_info() so that it accepts storage type and
storage size arguments instead of Tuplestorestate. This allows the
node types to share the formatting code using show_storage_info(). Due
to this show_material_info() and show_windowagg_info() are also
modified.

Reviewed-by: David Rowley
Discussion: https://postgr.es/m/20240918.211246.1127161704188186085.ishii%40postgresql.org

src/backend/commands/explain.c patch | blob | blame | history

diff --git a/src/backend/commands/explain.c b/src/backend/commands/explain.c
index aaec439892c75835ca8fd968b3abbf0b7773be38..ee1bcb84e2885333118a4a5a563f2396db953e9d 100644 (file)
--- a/src/backend/commands/explain.c
+++ b/src/backend/commands/explain.c
@@ -120,7 +120,8 @@ static void show_sort_group_keys(PlanState *planstate, const char *qlabel,
                                 List *ancestors, ExplainState *es);
 static void show_sortorder_options(StringInfo buf, Node *sortexpr,
                                   Oid sortOperator, Oid collation, bool nullsFirst);
-static void show_storage_info(Tuplestorestate *tupstore, ExplainState *es);
+static void show_storage_info(char *maxStorageType, int64 maxSpaceUsed,
+                             ExplainState *es);
 static void show_tablesample(TableSampleClause *tsc, PlanState *planstate,
                             List *ancestors, ExplainState *es);
 static void show_sort_info(SortState *sortstate, ExplainState *es);
@@ -129,6 +130,11 @@ static void show_incremental_sort_info(IncrementalSortState *incrsortstate,
 static void show_hash_info(HashState *hashstate, ExplainState *es);
 static void show_material_info(MaterialState *mstate, ExplainState *es);
 static void show_windowagg_info(WindowAggState *winstate, ExplainState *es);
+static void show_ctescan_info(CteScanState *ctescanstate, ExplainState *es);
+static void show_table_func_scan_info(TableFuncScanState *tscanstate,
+                                     ExplainState *es);
+static void show_recursive_union_info(RecursiveUnionState *rstate,
+                                     ExplainState *es);
 static void show_memoize_info(MemoizeState *mstate, List *ancestors,
                              ExplainState *es);
 static void show_hashagg_info(AggState *aggstate, ExplainState *es);
@@ -2046,6 +2052,8 @@ ExplainNode(PlanState *planstate, List *ancestors,
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
+           if (IsA(plan, CteScan))
+               show_ctescan_info(castNode(CteScanState, planstate), es);
            break;
        case T_Gather:
            {
@@ -2127,6 +2135,8 @@ ExplainNode(PlanState *planstate, List *ancestors,
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
+           show_table_func_scan_info(castNode(TableFuncScanState,
+                                              planstate), es);
            break;
        case T_TidScan:
            {
@@ -2278,6 +2288,10 @@ ExplainNode(PlanState *planstate, List *ancestors,
            show_memoize_info(castNode(MemoizeState, planstate), ancestors,
                              es);
            break;
+       case T_RecursiveUnion:
+           show_recursive_union_info(castNode(RecursiveUnionState,
+                                              planstate), es);
+           break;
        default:
            break;
    }
@@ -2901,14 +2915,9 @@ show_sortorder_options(StringInfo buf, Node *sortexpr,
  * Show information on storage method and maximum memory/disk space used.
  */
 static void
-show_storage_info(Tuplestorestate *tupstore, ExplainState *es)
+show_storage_info(char *maxStorageType, int64 maxSpaceUsed, ExplainState *es)
 {
-   char       *maxStorageType;
-   int64       maxSpaceUsed,
-               maxSpaceUsedKB;
-
-   tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
-   maxSpaceUsedKB = BYTES_TO_KILOBYTES(maxSpaceUsed);
+   int64       maxSpaceUsedKB = BYTES_TO_KILOBYTES(maxSpaceUsed);
 
    if (es->format != EXPLAIN_FORMAT_TEXT)
    {
@@ -3380,6 +3389,9 @@ show_hash_info(HashState *hashstate, ExplainState *es)
 static void
 show_material_info(MaterialState *mstate, ExplainState *es)
 {
+   char       *maxStorageType;
+   int64       maxSpaceUsed;
+
    Tuplestorestate *tupstore = mstate->tuplestorestate;
 
    /*
@@ -3389,7 +3401,8 @@ show_material_info(MaterialState *mstate, ExplainState *es)
    if (!es->analyze || tupstore == NULL)
        return;
 
-   show_storage_info(tupstore, es);
+   tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
+   show_storage_info(maxStorageType, maxSpaceUsed, es);
 }
 
 /*
@@ -3399,6 +3412,9 @@ show_material_info(MaterialState *mstate, ExplainState *es)
 static void
 show_windowagg_info(WindowAggState *winstate, ExplainState *es)
 {
+   char       *maxStorageType;
+   int64       maxSpaceUsed;
+
    Tuplestorestate *tupstore = winstate->buffer;
 
    /*
@@ -3408,7 +3424,78 @@ show_windowagg_info(WindowAggState *winstate, ExplainState *es)
    if (!es->analyze || tupstore == NULL)
        return;
 
-   show_storage_info(tupstore, es);
+   tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
+   show_storage_info(maxStorageType, maxSpaceUsed, es);
+}
+
+/*
+ * Show information on CTE Scan node, storage method and maximum memory/disk
+ * space used.
+ */
+static void
+show_ctescan_info(CteScanState *ctescanstate, ExplainState *es)
+{
+   char       *maxStorageType;
+   int64       maxSpaceUsed;
+
+   Tuplestorestate *tupstore = ctescanstate->leader->cte_table;
+
+   if (!es->analyze || tupstore == NULL)
+       return;
+
+   tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
+   show_storage_info(maxStorageType, maxSpaceUsed, es);
+}
+
+/*
+ * Show information on Table Function Scan node, storage method and maximum
+ * memory/disk space used.
+ */
+static void
+show_table_func_scan_info(TableFuncScanState *tscanstate, ExplainState *es)
+{
+   char       *maxStorageType;
+   int64       maxSpaceUsed;
+
+   Tuplestorestate *tupstore = tscanstate->tupstore;
+
+   if (!es->analyze || tupstore == NULL)
+       return;
+
+   tuplestore_get_stats(tupstore, &maxStorageType, &maxSpaceUsed);
+   show_storage_info(maxStorageType, maxSpaceUsed, es);
+}
+
+/*
+ * Show information on Recursive Union node, storage method and maximum
+ * memory/disk space used.
+ */
+static void
+show_recursive_union_info(RecursiveUnionState *rstate, ExplainState *es)
+{
+   char       *maxStorageType,
+              *tempStorageType;
+   int64       maxSpaceUsed,
+               tempSpaceUsed;
+
+   if (!es->analyze)
+       return;
+
+   /*
+    * Recursive union node uses two tuplestores.  We employ the storage type
+    * from one of them which consumed more memory/disk than the other.  The
+    * storage size is sum of the two.
+    */
+   tuplestore_get_stats(rstate->working_table, &tempStorageType,
+                        &tempSpaceUsed);
+   tuplestore_get_stats(rstate->intermediate_table, &maxStorageType,
+                        &maxSpaceUsed);
+
+   if (tempSpaceUsed > maxSpaceUsed)
+       maxStorageType = tempStorageType;
+
+   maxSpaceUsed += tempSpaceUsed;
+   show_storage_info(maxStorageType, maxSpaceUsed, es);
 }
 
 /*
This is the main PostgreSQL git repository.