From 64e3f1c52cfe393ebe6c9bfa2b355207befa2bea Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Fri, 31 Jan 2025 13:01:59 +0900 Subject: [PATCH v3 2/3] Optionally record a plan_id in PlannedStmt to identify plan shape When enabled via the new compute_plan_id GUC (default off), this utilizes the existing treewalk in setrefs.c after planning to calculate a hash (the "plan_id", or plan identifier) that can be used to identify which plan was chosen. The plan_id generally intends to be the same if a given EXPLAIN (without ANALYZE) output is the same. The plan_id includes both the top-level plan as well as all subplans. Execution statistics are excluded. If enabled, the plan_id is shown for currently running queries in pg_stat_activity, as well as recorded in EXPLAIN and auto_explain output. Other in core users or extensions can use this facility to show or accumulate statistics about the plans used by queries, to help identify plan regressions, or drive plan management decisions. Note that this commit intentionally does not include a facility to map a given plan_id to the EXPLAIN text output - it is a assumed that users can utilize the auto_explain extension to establish this mapping as needed, or extensions can record this via the existing planner hook. --- src/include/catalog/pg_proc.dat | 6 +- src/include/nodes/pathnodes.h | 3 + src/include/nodes/plannodes.h | 399 +++++++++++------- src/include/nodes/primnodes.h | 7 +- src/include/nodes/queryjumble.h | 34 +- src/include/utils/backend_status.h | 5 + src/backend/catalog/system_views.sql | 1 + src/backend/commands/explain.c | 16 + src/backend/executor/execMain.c | 10 +- src/backend/executor/execParallel.c | 1 + src/backend/nodes/gen_node_support.pl | 50 ++- src/backend/nodes/queryjumblefuncs.c | 78 +++- src/backend/optimizer/plan/planner.c | 18 + src/backend/optimizer/plan/setrefs.c | 9 + src/backend/postmaster/launch_backend.c | 3 + src/backend/tcop/postgres.c | 1 + src/backend/utils/activity/backend_status.c | 70 ++- src/backend/utils/adt/pgstatfuncs.c | 7 +- src/backend/utils/misc/guc_tables.c | 28 ++ src/backend/utils/misc/postgresql.conf.sample | 1 + src/test/regress/expected/explain.out | 11 + src/test/regress/expected/rules.out | 9 +- src/test/regress/sql/explain.sql | 4 + doc/src/sgml/config.sgml | 34 ++ doc/src/sgml/monitoring.sgml | 16 + 25 files changed, 635 insertions(+), 186 deletions(-) diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 5b8c2ad2a54..5547db7d2f1 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -5568,9 +5568,9 @@ proname => 'pg_stat_get_activity', prorows => '100', proisstrict => 'f', proretset => 't', provolatile => 's', proparallel => 'r', prorettype => 'record', proargtypes => 'int4', - proallargtypes => '{int4,oid,int4,oid,text,text,text,text,text,timestamptz,timestamptz,timestamptz,timestamptz,inet,text,int4,xid,xid,text,bool,text,text,int4,text,numeric,text,bool,text,bool,bool,int4,int8}', - proargmodes => '{i,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{pid,datid,pid,usesysid,application_name,state,query,wait_event_type,wait_event,xact_start,query_start,backend_start,state_change,client_addr,client_hostname,client_port,backend_xid,backend_xmin,backend_type,ssl,sslversion,sslcipher,sslbits,ssl_client_dn,ssl_client_serial,ssl_issuer_dn,gss_auth,gss_princ,gss_enc,gss_delegation,leader_pid,query_id}', + proallargtypes => '{int4,oid,int4,oid,text,text,text,text,text,timestamptz,timestamptz,timestamptz,timestamptz,inet,text,int4,xid,xid,text,bool,text,text,int4,text,numeric,text,bool,text,bool,bool,int4,int8,int8}', + proargmodes => '{i,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{pid,datid,pid,usesysid,application_name,state,query,wait_event_type,wait_event,xact_start,query_start,backend_start,state_change,client_addr,client_hostname,client_port,backend_xid,backend_xmin,backend_type,ssl,sslversion,sslcipher,sslbits,ssl_client_dn,ssl_client_serial,ssl_issuer_dn,gss_auth,gss_princ,gss_enc,gss_delegation,leader_pid,query_id,plan_id}', prosrc => 'pg_stat_get_activity' }, { oid => '6318', descr => 'describe wait events', proname => 'pg_get_wait_events', procost => '10', prorows => '250', diff --git a/src/include/nodes/pathnodes.h b/src/include/nodes/pathnodes.h index 52d44f43021..9603e0edda0 100644 --- a/src/include/nodes/pathnodes.h +++ b/src/include/nodes/pathnodes.h @@ -166,6 +166,9 @@ typedef struct PlannerGlobal /* partition descriptors */ PartitionDirectory partition_directory pg_node_attr(read_write_ignore); + + /* optional jumble state for plan identifier claculation */ + struct JumbleState *plan_jumble_state pg_node_attr(read_write_ignore); } PlannerGlobal; /* macro for fetching the Plan associated with a SubPlan node */ diff --git a/src/include/nodes/plannodes.h b/src/include/nodes/plannodes.h index 8143744e89c..f5574baf379 100644 --- a/src/include/nodes/plannodes.h +++ b/src/include/nodes/plannodes.h @@ -53,6 +53,10 @@ typedef struct PlannedStmt uint64 queryId; /* query identifier (copied from Query) */ + uint64 planId; /* plan identifier (calculated if + * compute_plan_id is enabled, can also be set + * by plugins) */ + bool hasReturning; /* is it insert|update|delete|merge RETURNING? */ bool hasModifyingCTE; /* has insert|update|delete|merge in WITH? */ @@ -121,44 +125,55 @@ typedef struct PlannedStmt */ typedef struct Plan { - pg_node_attr(abstract, no_equal, no_query_jumble) + pg_node_attr(abstract, no_equal) NodeTag type; /* * estimated execution costs for plan (see costsize.c for more info) */ - int disabled_nodes; /* count of disabled nodes */ - Cost startup_cost; /* cost expended before fetching any tuples */ - Cost total_cost; /* total cost (assuming all tuples fetched) */ + int disabled_nodes pg_node_attr(query_jumble_ignore); /* count of disabled + * nodes */ + Cost startup_cost pg_node_attr(query_jumble_ignore); /* cost expended before + * fetching any tuples */ + Cost total_cost pg_node_attr(query_jumble_ignore); /* total cost (assuming + * all tuples fetched) */ /* * planner's estimate of result size of this plan step */ - Cardinality plan_rows; /* number of rows plan is expected to emit */ - int plan_width; /* average row width in bytes */ + Cardinality plan_rows pg_node_attr(query_jumble_ignore); /* number of rows plan + * is expected to emit */ + int plan_width pg_node_attr(query_jumble_ignore); /* average row width in + * bytes */ /* * information needed for parallel query */ - bool parallel_aware; /* engage parallel-aware logic? */ - bool parallel_safe; /* OK to use as part of parallel plan? */ + bool parallel_aware pg_node_attr(query_jumble_ignore); /* engage parallel-aware + * logic? */ + bool parallel_safe pg_node_attr(query_jumble_ignore); /* OK to use as part of + * parallel plan? */ /* * information needed for asynchronous execution */ - bool async_capable; /* engage asynchronous-capable logic? */ + bool async_capable pg_node_attr(query_jumble_ignore); /* engage + * asynchronous-capable + * logic? */ /* * Common structural data for all Plan types. */ - int plan_node_id; /* unique across entire final plan tree */ + int plan_node_id pg_node_attr(query_jumble_ignore); /* unique across entire + * final plan tree */ List *targetlist; /* target list to be computed at this node */ List *qual; /* implicitly-ANDed qual conditions */ - struct Plan *lefttree; /* input plan tree(s) */ - struct Plan *righttree; - List *initPlan; /* Init Plan nodes (un-correlated expr - * subselects) */ + struct Plan *lefttree pg_node_attr(query_jumble_ignore); /* input plan tree(s) */ + struct Plan *righttree pg_node_attr(query_jumble_ignore); + List *initPlan pg_node_attr(query_jumble_ignore); /* Init Plan nodes + * (un-correlated expr + * subselects) */ /* * Information for management of parameter-change-driven rescanning @@ -171,8 +186,8 @@ typedef struct Plan * params that affect the node (i.e., the setParams of its initplans). * These are _all_ the PARAM_EXEC params that affect this node. */ - Bitmapset *extParam; - Bitmapset *allParam; + Bitmapset *extParam pg_node_attr(query_jumble_ignore); + Bitmapset *allParam pg_node_attr(query_jumble_ignore); } Plan; /* ---------------- @@ -234,31 +249,47 @@ typedef struct ModifyTable { Plan plan; CmdType operation; /* INSERT, UPDATE, DELETE, or MERGE */ - bool canSetTag; /* do we set the command tag/es_processed? */ - Index nominalRelation; /* Parent RT index for use of EXPLAIN */ - Index rootRelation; /* Root RT index, if partitioned/inherited */ + bool canSetTag pg_node_attr(query_jumble_ignore); /* do we set the command + * tag/es_processed? */ + Index nominalRelation pg_node_attr(query_jumble_ignore); /* Parent RT index for + * use of EXPLAIN */ + Index rootRelation pg_node_attr(query_jumble_rt_index); /* Root RT index, if + * partitioned/inherited */ bool partColsUpdated; /* some part key in hierarchy updated? */ - List *resultRelations; /* integer list of RT indexes */ - List *updateColnosLists; /* per-target-table update_colnos lists */ - List *withCheckOptionLists; /* per-target-table WCO lists */ - char *returningOldAlias; /* alias for OLD in RETURNING lists */ - char *returningNewAlias; /* alias for NEW in RETURNING lists */ - List *returningLists; /* per-target-table RETURNING tlists */ - List *fdwPrivLists; /* per-target-table FDW private data lists */ - Bitmapset *fdwDirectModifyPlans; /* indices of FDW DM plans */ - List *rowMarks; /* PlanRowMarks (non-locking only) */ - int epqParam; /* ID of Param for EvalPlanQual re-eval */ + List *resultRelations pg_node_attr(query_jumble_rt_index); /* integer list of RT + * indexes */ + List *updateColnosLists pg_node_attr(query_jumble_ignore); /* per-target-table + * update_colnos lists */ + List *withCheckOptionLists pg_node_attr(query_jumble_ignore); /* per-target-table WCO + * lists */ + char *returningOldAlias pg_node_attr(query_jumble_ignore); /* alias for OLD in + * RETURNING lists */ + char *returningNewAlias pg_node_attr(query_jumble_ignore); /* alias for NEW in + * RETURNING lists */ + List *returningLists pg_node_attr(query_jumble_ignore); /* per-target-table + * RETURNING tlists */ + List *fdwPrivLists pg_node_attr(query_jumble_ignore); /* per-target-table FDW + * private data lists */ + Bitmapset *fdwDirectModifyPlans pg_node_attr(query_jumble_ignore); /* indices of FDW DM + * plans */ + List *rowMarks pg_node_attr(query_jumble_ignore); /* PlanRowMarks + * (non-locking only) */ + int epqParam pg_node_attr(query_jumble_ignore); /* ID of Param for + * EvalPlanQual re-eval */ OnConflictAction onConflictAction; /* ON CONFLICT action */ List *arbiterIndexes; /* List of ON CONFLICT arbiter index OIDs */ List *onConflictSet; /* INSERT ON CONFLICT DO UPDATE targetlist */ List *onConflictCols; /* target column numbers for onConflictSet */ Node *onConflictWhere; /* WHERE for ON CONFLICT UPDATE */ - Index exclRelRTI; /* RTI of the EXCLUDED pseudo relation */ - List *exclRelTlist; /* tlist of the EXCLUDED pseudo relation */ - List *mergeActionLists; /* per-target-table lists of actions for - * MERGE */ - List *mergeJoinConditions; /* per-target-table join conditions - * for MERGE */ + Index exclRelRTI pg_node_attr(query_jumble_ignore); /* RTI of the EXCLUDED + * pseudo relation */ + List *exclRelTlist pg_node_attr(query_jumble_ignore); /* tlist of the EXCLUDED + * pseudo relation */ + List *mergeActionLists pg_node_attr(query_jumble_ignore); /* per-target-table + * lists of actions for + * MERGE */ + List *mergeJoinConditions pg_node_attr(query_jumble_ignore); /* per-target-table join + * conditions for MERGE */ } ModifyTable; struct PartitionPruneInfo; /* forward reference to struct below */ @@ -271,18 +302,20 @@ struct PartitionPruneInfo; /* forward reference to struct below */ typedef struct Append { Plan plan; - Bitmapset *apprelids; /* RTIs of appendrel(s) formed by this node */ - List *appendplans; - int nasyncplans; /* # of asynchronous plans */ + /* RTIs of appendrel(s) formed by this node */ + Bitmapset *apprelids pg_node_attr(query_jumble_ignore); + List *appendplans pg_node_attr(query_jumble_ignore); + /* # of asynchronous plans */ + int nasyncplans pg_node_attr(query_jumble_ignore); /* * All 'appendplans' preceding this index are non-partial plans. All * 'appendplans' from this index onwards are partial plans. */ - int first_partial_plan; + int first_partial_plan pg_node_attr(query_jumble_ignore); /* Index to PlannerInfo.partPruneInfos or -1 if no run-time pruning */ - int part_prune_index; + int part_prune_index pg_node_attr(query_jumble_ignore); } Append; /* ---------------- @@ -295,29 +328,29 @@ typedef struct MergeAppend Plan plan; /* RTIs of appendrel(s) formed by this node */ - Bitmapset *apprelids; + Bitmapset *apprelids pg_node_attr(query_jumble_ignore); - List *mergeplans; + List *mergeplans pg_node_attr(query_jumble_ignore); /* these fields are just like the sort-key info in struct Sort: */ /* number of sort-key columns */ - int numCols; + int numCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *sortColIdx pg_node_attr(array_size(numCols)); + AttrNumber *sortColIdx pg_node_attr(array_size(numCols), query_jumble_ignore); /* OIDs of operators to sort them by */ - Oid *sortOperators pg_node_attr(array_size(numCols)); + Oid *sortOperators pg_node_attr(array_size(numCols), query_jumble_ignore); /* OIDs of collations */ - Oid *collations pg_node_attr(array_size(numCols)); + Oid *collations pg_node_attr(array_size(numCols), query_jumble_ignore); /* NULLS FIRST/LAST directions */ - bool *nullsFirst pg_node_attr(array_size(numCols)); + bool *nullsFirst pg_node_attr(array_size(numCols), query_jumble_ignore); /* Index to PlannerInfo.partPruneInfos or -1 if no run-time pruning */ - int part_prune_index; + int part_prune_index pg_node_attr(query_jumble_ignore); } MergeAppend; /* ---------------- @@ -333,22 +366,22 @@ typedef struct RecursiveUnion Plan plan; /* ID of Param representing work table */ - int wtParam; + int wtParam pg_node_attr(query_jumble_ignore); /* Remaining fields are zero/null in UNION ALL case */ /* number of columns to check for duplicate-ness */ - int numCols; + int numCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *dupColIdx pg_node_attr(array_size(numCols)); + AttrNumber *dupColIdx pg_node_attr(array_size(numCols), query_jumble_ignore); /* equality operators to compare with */ - Oid *dupOperators pg_node_attr(array_size(numCols)); - Oid *dupCollations pg_node_attr(array_size(numCols)); + Oid *dupOperators pg_node_attr(array_size(numCols), query_jumble_ignore); + Oid *dupCollations pg_node_attr(array_size(numCols), query_jumble_ignore); /* estimated number of groups in input */ - long numGroups; + long numGroups pg_node_attr(query_jumble_ignore); } RecursiveUnion; /* ---------------- @@ -362,7 +395,7 @@ typedef struct RecursiveUnion typedef struct BitmapAnd { Plan plan; - List *bitmapplans; + List *bitmapplans pg_node_attr(query_jumble_ignore); } BitmapAnd; /* ---------------- @@ -376,8 +409,8 @@ typedef struct BitmapAnd typedef struct BitmapOr { Plan plan; - bool isshared; - List *bitmapplans; + bool isshared pg_node_attr(query_jumble_ignore); + List *bitmapplans pg_node_attr(query_jumble_ignore); } BitmapOr; /* @@ -392,7 +425,8 @@ typedef struct Scan pg_node_attr(abstract) Plan plan; - Index scanrelid; /* relid is index into the range table */ + Index scanrelid pg_node_attr(query_jumble_rt_index); /* relid is index into + * the range table */ } Scan; /* ---------------- @@ -457,9 +491,11 @@ typedef struct IndexScan Scan scan; Oid indexid; /* OID of index to scan */ List *indexqual; /* list of index quals (usually OpExprs) */ - List *indexqualorig; /* the same in original form */ + List *indexqualorig pg_node_attr(query_jumble_ignore); /* the same in original + * form */ List *indexorderby; /* list of index ORDER BY exprs */ - List *indexorderbyorig; /* the same in original form */ + List *indexorderbyorig pg_node_attr(query_jumble_ignore); /* the same in original + * form */ List *indexorderbyops; /* OIDs of sort ops for ORDER BY exprs */ ScanDirection indexorderdir; /* forward or backward or don't care */ } IndexScan; @@ -500,9 +536,12 @@ typedef struct IndexOnlyScan Scan scan; Oid indexid; /* OID of index to scan */ List *indexqual; /* list of index quals (usually OpExprs) */ - List *recheckqual; /* index quals in recheckable form */ + List *recheckqual pg_node_attr(query_jumble_ignore); /* index quals in + * recheckable form */ List *indexorderby; /* list of index ORDER BY exprs */ - List *indextlist; /* TargetEntry list describing index's cols */ + List *indextlist pg_node_attr(query_jumble_ignore); /* TargetEntry list + * describing index's + * cols */ ScanDirection indexorderdir; /* forward or backward or don't care */ } IndexOnlyScan; @@ -527,9 +566,11 @@ typedef struct BitmapIndexScan { Scan scan; Oid indexid; /* OID of index to scan */ - bool isshared; /* Create shared bitmap if set */ + bool isshared pg_node_attr(query_jumble_ignore); /* Create shared bitmap + * if set */ List *indexqual; /* list of index quals (OpExprs) */ - List *indexqualorig; /* the same in original form */ + List *indexqualorig pg_node_attr(query_jumble_ignore); /* the same in original + * form */ } BitmapIndexScan; /* ---------------- @@ -544,7 +585,8 @@ typedef struct BitmapIndexScan typedef struct BitmapHeapScan { Scan scan; - List *bitmapqualorig; /* index quals, in standard expr form */ + List *bitmapqualorig pg_node_attr(query_jumble_ignore); /* index quals, in + * standard expr form */ } BitmapHeapScan; /* ---------------- @@ -604,8 +646,8 @@ typedef enum SubqueryScanStatus typedef struct SubqueryScan { Scan scan; - Plan *subplan; - SubqueryScanStatus scanstatus; + Plan *subplan pg_node_attr(query_jumble_ignore); + SubqueryScanStatus scanstatus pg_node_attr(query_jumble_ignore); } SubqueryScan; /* ---------------- @@ -646,8 +688,11 @@ typedef struct TableFuncScan typedef struct CteScan { Scan scan; - int ctePlanId; /* ID of init SubPlan for CTE */ - int cteParam; /* ID of Param representing CTE output */ + int ctePlanId pg_node_attr(query_jumble_ignore); /* ID of init SubPlan + * for CTE */ + int cteParam pg_node_attr(query_jumble_ignore); /* ID of Param + * representing CTE + * output */ } CteScan; /* ---------------- @@ -667,7 +712,9 @@ typedef struct NamedTuplestoreScan typedef struct WorkTableScan { Scan scan; - int wtParam; /* ID of Param representing work table */ + int wtParam pg_node_attr(query_jumble_ignore); /* ID of Param + * representing work + * table */ } WorkTableScan; /* ---------------- @@ -714,17 +761,26 @@ typedef struct ForeignScan { Scan scan; CmdType operation; /* SELECT/INSERT/UPDATE/DELETE */ - Index resultRelation; /* direct modification target's RT index */ - Oid checkAsUser; /* user to perform the scan as; 0 means to - * check as current user */ + Index resultRelation pg_node_attr(query_jumble_ignore); /* direct modification + * target's RT index */ + Oid checkAsUser pg_node_attr(query_jumble_ignore); /* user to perform the + * scan as; 0 means to + * check as current user */ Oid fs_server; /* OID of foreign server */ - List *fdw_exprs; /* expressions that FDW may evaluate */ - List *fdw_private; /* private data for FDW */ - List *fdw_scan_tlist; /* optional tlist describing scan tuple */ - List *fdw_recheck_quals; /* original quals not in scan.plan.qual */ - Bitmapset *fs_relids; /* base+OJ RTIs generated by this scan */ - Bitmapset *fs_base_relids; /* base RTIs generated by this scan */ - bool fsSystemCol; /* true if any "system column" is needed */ + List *fdw_exprs pg_node_attr(query_jumble_ignore); /* expressions that FDW + * may evaluate */ + List *fdw_private pg_node_attr(query_jumble_ignore); /* private data for FDW */ + List *fdw_scan_tlist pg_node_attr(query_jumble_ignore); /* optional tlist + * describing scan tuple */ + List *fdw_recheck_quals pg_node_attr(query_jumble_ignore); /* original quals not in + * scan.plan.qual */ + Bitmapset *fs_relids pg_node_attr(query_jumble_ignore); /* base+OJ RTIs + * generated by this + * scan */ + Bitmapset *fs_base_relids pg_node_attr(query_jumble_ignore); /* base RTIs generated + * by this scan */ + bool fsSystemCol pg_node_attr(query_jumble_ignore); /* true if any "system + * column" is needed */ } ForeignScan; /* ---------------- @@ -745,20 +801,27 @@ struct CustomScanMethods; typedef struct CustomScan { Scan scan; - uint32 flags; /* mask of CUSTOMPATH_* flags, see - * nodes/extensible.h */ - List *custom_plans; /* list of Plan nodes, if any */ - List *custom_exprs; /* expressions that custom code may evaluate */ - List *custom_private; /* private data for custom code */ - List *custom_scan_tlist; /* optional tlist describing scan tuple */ - Bitmapset *custom_relids; /* RTIs generated by this scan */ + uint32 flags pg_node_attr(query_jumble_ignore); /* mask of CUSTOMPATH_* + * flags, see + * nodes/extensible.h */ + List *custom_plans pg_node_attr(query_jumble_ignore); /* list of Plan nodes, + * if any */ + List *custom_exprs pg_node_attr(query_jumble_ignore); /* expressions that + * custom code may + * evaluate */ + List *custom_private pg_node_attr(query_jumble_ignore); /* private data for + * custom code */ + List *custom_scan_tlist pg_node_attr(query_jumble_ignore); /* optional tlist + * describing scan tuple */ + Bitmapset *custom_relids pg_node_attr(query_jumble_ignore); /* RTIs generated by + * this scan */ /* * NOTE: The method field of CustomScan is required to be a pointer to a * static table of callback functions. So we don't copy the table itself, * just reference the original one. */ - const struct CustomScanMethods *methods; + const struct CustomScanMethods *methods pg_node_attr(query_jumble_ignore); } CustomScan; /* @@ -795,7 +858,7 @@ typedef struct Join Plan plan; JoinType jointype; - bool inner_unique; + bool inner_unique pg_node_attr(query_jumble_ignore); List *joinqual; /* JOIN quals (in addition to plan.qual) */ } Join; @@ -818,7 +881,7 @@ typedef struct NestLoop typedef struct NestLoopParam { - pg_node_attr(no_equal, no_query_jumble) + pg_node_attr(no_equal) NodeTag type; int paramno; /* number of the PARAM_EXEC Param to set */ @@ -841,7 +904,7 @@ typedef struct MergeJoin Join join; /* Can we skip mark/restore calls? */ - bool skip_mark_restore; + bool skip_mark_restore pg_node_attr(query_jumble_ignore); /* mergeclauses as expression trees */ List *mergeclauses; @@ -897,13 +960,13 @@ typedef struct Memoize Plan plan; /* size of the two arrays below */ - int numKeys; + int numKeys pg_node_attr(query_jumble_ignore); /* hash operators for each key */ - Oid *hashOperators pg_node_attr(array_size(numKeys)); + Oid *hashOperators pg_node_attr(array_size(numKeys), query_jumble_ignore); /* collations for each key */ - Oid *collations pg_node_attr(array_size(numKeys)); + Oid *collations pg_node_attr(array_size(numKeys), query_jumble_ignore); /* cache keys in the form of exprs containing parameters */ List *param_exprs; @@ -912,7 +975,7 @@ typedef struct Memoize * true if the cache entry should be marked as complete after we store the * first tuple in it. */ - bool singlerow; + bool singlerow pg_node_attr(query_jumble_ignore); /* * true when cache key should be compared bit by bit, false when using @@ -924,10 +987,10 @@ typedef struct Memoize * The maximum number of entries that the planner expects will fit in the * cache, or 0 if unknown */ - uint32 est_entries; + uint32 est_entries pg_node_attr(query_jumble_ignore); /* paramids from param_exprs */ - Bitmapset *keyparamids; + Bitmapset *keyparamids pg_node_attr(query_jumble_ignore); } Memoize; /* ---------------- @@ -1010,31 +1073,31 @@ typedef struct Agg AggSplit aggsplit; /* number of grouping columns */ - int numCols; + int numCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *grpColIdx pg_node_attr(array_size(numCols)); + AttrNumber *grpColIdx pg_node_attr(array_size(numCols), query_jumble_ignore); /* equality operators to compare with */ - Oid *grpOperators pg_node_attr(array_size(numCols)); - Oid *grpCollations pg_node_attr(array_size(numCols)); + Oid *grpOperators pg_node_attr(array_size(numCols), query_jumble_ignore); + Oid *grpCollations pg_node_attr(array_size(numCols), query_jumble_ignore); /* estimated number of groups in input */ - long numGroups; + long numGroups pg_node_attr(query_jumble_ignore); /* for pass-by-ref transition data */ - uint64 transitionSpace; + uint64 transitionSpace pg_node_attr(query_jumble_ignore); /* IDs of Params used in Aggref inputs */ - Bitmapset *aggParams; + Bitmapset *aggParams pg_node_attr(query_jumble_ignore); /* Note: planner provides numGroups & aggParams only in HASHED/MIXED case */ /* grouping sets to use */ - List *groupingSets; + List *groupingSets pg_node_attr(query_jumble_ignore); /* chained Agg/Sort nodes */ - List *chain; + List *chain pg_node_attr(query_jumble_ignore); } Agg; /* ---------------- @@ -1046,43 +1109,43 @@ typedef struct WindowAgg Plan plan; /* ID referenced by window functions */ - Index winref; + Index winref pg_node_attr(query_jumble_ignore); /* number of columns in partition clause */ - int partNumCols; + int partNumCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *partColIdx pg_node_attr(array_size(partNumCols)); + AttrNumber *partColIdx pg_node_attr(array_size(partNumCols), query_jumble_ignore); /* equality operators for partition columns */ - Oid *partOperators pg_node_attr(array_size(partNumCols)); + Oid *partOperators pg_node_attr(array_size(partNumCols), query_jumble_ignore); /* collations for partition columns */ - Oid *partCollations pg_node_attr(array_size(partNumCols)); + Oid *partCollations pg_node_attr(array_size(partNumCols), query_jumble_ignore); /* number of columns in ordering clause */ - int ordNumCols; + int ordNumCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *ordColIdx pg_node_attr(array_size(ordNumCols)); + AttrNumber *ordColIdx pg_node_attr(array_size(ordNumCols), query_jumble_ignore); /* equality operators for ordering columns */ - Oid *ordOperators pg_node_attr(array_size(ordNumCols)); + Oid *ordOperators pg_node_attr(array_size(ordNumCols), query_jumble_ignore); /* collations for ordering columns */ - Oid *ordCollations pg_node_attr(array_size(ordNumCols)); + Oid *ordCollations pg_node_attr(array_size(ordNumCols), query_jumble_ignore); /* frame_clause options, see WindowDef */ - int frameOptions; + int frameOptions pg_node_attr(query_jumble_ignore); /* expression for starting bound, if any */ - Node *startOffset; + Node *startOffset pg_node_attr(query_jumble_ignore); /* expression for ending bound, if any */ - Node *endOffset; + Node *endOffset pg_node_attr(query_jumble_ignore); /* qual to help short-circuit execution */ - List *runCondition; + List *runCondition pg_node_attr(query_jumble_ignore); /* runCondition for display in EXPLAIN */ List *runConditionOrig; @@ -1090,25 +1153,25 @@ typedef struct WindowAgg /* these fields are used with RANGE offset PRECEDING/FOLLOWING: */ /* in_range function for startOffset */ - Oid startInRangeFunc; + Oid startInRangeFunc pg_node_attr(query_jumble_ignore); /* in_range function for endOffset */ - Oid endInRangeFunc; + Oid endInRangeFunc pg_node_attr(query_jumble_ignore); /* collation for in_range tests */ - Oid inRangeColl; + Oid inRangeColl pg_node_attr(query_jumble_ignore); /* use ASC sort order for in_range tests? */ - bool inRangeAsc; + bool inRangeAsc pg_node_attr(query_jumble_ignore); /* nulls sort first for in_range tests? */ - bool inRangeNullsFirst; + bool inRangeNullsFirst pg_node_attr(query_jumble_ignore); /* * false for all apart from the WindowAgg that's closest to the root of * the plan */ - bool topWindow; + bool topWindow pg_node_attr(query_jumble_ignore); } WindowAgg; /* ---------------- @@ -1120,16 +1183,16 @@ typedef struct Unique Plan plan; /* number of columns to check for uniqueness */ - int numCols; + int numCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *uniqColIdx pg_node_attr(array_size(numCols)); + AttrNumber *uniqColIdx pg_node_attr(array_size(numCols), query_jumble_ignore); /* equality operators to compare with */ - Oid *uniqOperators pg_node_attr(array_size(numCols)); + Oid *uniqOperators pg_node_attr(array_size(numCols), query_jumble_ignore); /* collations for equality comparisons */ - Oid *uniqCollations pg_node_attr(array_size(numCols)); + Oid *uniqCollations pg_node_attr(array_size(numCols), query_jumble_ignore); } Unique; /* ------------ @@ -1146,12 +1209,19 @@ typedef struct Unique typedef struct Gather { Plan plan; - int num_workers; /* planned number of worker processes */ - int rescan_param; /* ID of Param that signals a rescan, or -1 */ - bool single_copy; /* don't execute plan more than once */ - bool invisible; /* suppress EXPLAIN display (for testing)? */ - Bitmapset *initParam; /* param id's of initplans which are referred - * at gather or one of its child nodes */ + /* planned number of worker processes */ + int num_workers; + /* ID of Param that signals a rescan, or -1 */ + int rescan_param pg_node_attr(query_jumble_ignore); + /* don't execute plan more than once */ + bool single_copy pg_node_attr(query_jumble_ignore); + /* suppress EXPLAIN display (for testing)? */ + bool invisible pg_node_attr(query_jumble_ignore); + /* + * param id's of initplans which are referred at gather or one of its + * child nodes + */ + Bitmapset *initParam pg_node_attr(query_jumble_ignore); } Gather; /* ------------ @@ -1166,30 +1236,30 @@ typedef struct GatherMerge int num_workers; /* ID of Param that signals a rescan, or -1 */ - int rescan_param; + int rescan_param pg_node_attr(query_jumble_ignore); /* remaining fields are just like the sort-key info in struct Sort */ /* number of sort-key columns */ - int numCols; + int numCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *sortColIdx pg_node_attr(array_size(numCols)); + AttrNumber *sortColIdx pg_node_attr(array_size(numCols), query_jumble_ignore); /* OIDs of operators to sort them by */ - Oid *sortOperators pg_node_attr(array_size(numCols)); + Oid *sortOperators pg_node_attr(array_size(numCols), query_jumble_ignore); /* OIDs of collations */ - Oid *collations pg_node_attr(array_size(numCols)); + Oid *collations pg_node_attr(array_size(numCols), query_jumble_ignore); /* NULLS FIRST/LAST directions */ - bool *nullsFirst pg_node_attr(array_size(numCols)); + bool *nullsFirst pg_node_attr(array_size(numCols), query_jumble_ignore); /* * param id's of initplans which are referred at gather merge or one of * its child nodes */ - Bitmapset *initParam; + Bitmapset *initParam pg_node_attr(query_jumble_ignore); } GatherMerge; /* ---------------- @@ -1209,11 +1279,16 @@ typedef struct Hash * needed to put them into the hashtable. */ List *hashkeys; /* hash keys for the hashjoin condition */ - Oid skewTable; /* outer join key's table OID, or InvalidOid */ - AttrNumber skewColumn; /* outer join key's column #, or zero */ - bool skewInherit; /* is outer join rel an inheritance tree? */ + Oid skewTable pg_node_attr(query_jumble_ignore); /* outer join key's + * table OID, or + * InvalidOid */ + AttrNumber skewColumn pg_node_attr(query_jumble_ignore); /* outer join key's + * column #, or zero */ + bool skewInherit pg_node_attr(query_jumble_ignore); /* is outer join rel an + * inheritance tree? */ /* all other info is in the parent HashJoin node */ - Cardinality rows_total; /* estimate total rows if parallel_aware */ + Cardinality rows_total pg_node_attr(query_jumble_ignore); /* estimate total rows + * if parallel_aware */ } Hash; /* ---------------- @@ -1231,20 +1306,20 @@ typedef struct SetOp SetOpStrategy strategy; /* number of columns to compare */ - int numCols; + int numCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *cmpColIdx pg_node_attr(array_size(numCols)); + AttrNumber *cmpColIdx pg_node_attr(array_size(numCols), query_jumble_ignore); /* comparison operators (either equality operators or sort operators) */ - Oid *cmpOperators pg_node_attr(array_size(numCols)); - Oid *cmpCollations pg_node_attr(array_size(numCols)); + Oid *cmpOperators pg_node_attr(array_size(numCols), query_jumble_ignore); + Oid *cmpCollations pg_node_attr(array_size(numCols), query_jumble_ignore); /* nulls-first flags if sorting, otherwise not interesting */ - bool *cmpNullsFirst pg_node_attr(array_size(numCols)); + bool *cmpNullsFirst pg_node_attr(array_size(numCols), query_jumble_ignore); /* estimated number of groups in left input */ - long numGroups; + long numGroups pg_node_attr(query_jumble_ignore); } SetOp; /* ---------------- @@ -1259,8 +1334,10 @@ typedef struct SetOp typedef struct LockRows { Plan plan; - List *rowMarks; /* a list of PlanRowMark's */ - int epqParam; /* ID of Param for EvalPlanQual re-eval */ + List *rowMarks pg_node_attr(query_jumble_ignore); /* a list of + * PlanRowMark's */ + int epqParam pg_node_attr(query_jumble_ignore); /* ID of Param for + * EvalPlanQual re-eval */ } LockRows; /* ---------------- @@ -1275,25 +1352,25 @@ typedef struct Limit Plan plan; /* OFFSET parameter, or NULL if none */ - Node *limitOffset; + Node *limitOffset pg_node_attr(query_jumble_ignore); /* COUNT parameter, or NULL if none */ - Node *limitCount; + Node *limitCount pg_node_attr(query_jumble_ignore); /* limit type */ - LimitOption limitOption; + LimitOption limitOption pg_node_attr(query_jumble_ignore); /* number of columns to check for similarity */ - int uniqNumCols; + int uniqNumCols pg_node_attr(query_jumble_ignore); /* their indexes in the target list */ - AttrNumber *uniqColIdx pg_node_attr(array_size(uniqNumCols)); + AttrNumber *uniqColIdx pg_node_attr(array_size(uniqNumCols), query_jumble_ignore); /* equality operators to compare with */ - Oid *uniqOperators pg_node_attr(array_size(uniqNumCols)); + Oid *uniqOperators pg_node_attr(array_size(uniqNumCols), query_jumble_ignore); /* collations for equality comparisons */ - Oid *uniqCollations pg_node_attr(array_size(uniqNumCols)); + Oid *uniqCollations pg_node_attr(array_size(uniqNumCols), query_jumble_ignore); } Limit; diff --git a/src/include/nodes/primnodes.h b/src/include/nodes/primnodes.h index 59e7bb26bbd..c09785a0728 100644 --- a/src/include/nodes/primnodes.h +++ b/src/include/nodes/primnodes.h @@ -1074,8 +1074,6 @@ typedef struct SubLink */ typedef struct SubPlan { - pg_node_attr(no_query_jumble) - Expr xpr; /* Fields copied from original SubLink: */ SubLinkType subLinkType; /* see above */ @@ -1106,8 +1104,9 @@ typedef struct SubPlan List *parParam; /* indices of input Params from parent plan */ List *args; /* exprs to pass as parParam values */ /* Estimated execution costs: */ - Cost startup_cost; /* one-time setup cost */ - Cost per_call_cost; /* cost for each subplan evaluation */ + Cost startup_cost pg_node_attr(query_jumble_ignore); /* one-time setup cost */ + Cost per_call_cost pg_node_attr(query_jumble_ignore); /* cost for each subplan + * evaluation */ } SubPlan; /* diff --git a/src/include/nodes/queryjumble.h b/src/include/nodes/queryjumble.h index 5afa6f3605f..6c3b787b46f 100644 --- a/src/include/nodes/queryjumble.h +++ b/src/include/nodes/queryjumble.h @@ -15,6 +15,7 @@ #define QUERYJUMBLE_H #include "nodes/parsenodes.h" +#include "nodes/pathnodes.h" /* * Struct for tracking locations/lengths of constants during normalization @@ -48,6 +49,9 @@ typedef struct JumbleState /* highest Param id we've seen, in order to start normalization correctly */ int highest_extern_param_id; + + /* planner global info for resolving RT indexes when plan jumbling */ + PlannerGlobal *glob; } JumbleState; /* Values for the compute_query_id GUC */ @@ -59,15 +63,27 @@ enum ComputeQueryIdType COMPUTE_QUERY_ID_REGRESS, }; +/* Values for the compute_plan_id GUC */ +enum ComputePlanIdType +{ + COMPUTE_PLAN_ID_OFF, + COMPUTE_PLAN_ID_ON, + COMPUTE_PLAN_ID_AUTO, + COMPUTE_PLAN_ID_REGRESS, +}; + /* GUC parameters */ extern PGDLLIMPORT int compute_query_id; +extern PGDLLIMPORT int compute_plan_id; extern const char *CleanQuerytext(const char *query, int *location, int *len); extern JumbleState *JumbleQuery(Query *query); extern void EnableQueryId(void); +extern void EnablePlanId(void); extern PGDLLIMPORT bool query_id_enabled; +extern PGDLLIMPORT bool plan_id_enabled; /* * Returns whether query identifier computation has been enabled, either @@ -83,8 +99,22 @@ IsQueryIdEnabled(void) return query_id_enabled; } -/* Functions intended for other users of jumbling (e.g. plan jumbling) */ -extern JumbleState *InitializeJumbleState(bool record_clocations); +/* + * Returns whether plan identifier computation has been enabled, either + * directly in the GUC or by a module when the setting is 'auto'. + */ +static inline bool +IsPlanIdEnabled(void) +{ + if (compute_plan_id == COMPUTE_PLAN_ID_OFF) + return false; + if (compute_plan_id == COMPUTE_PLAN_ID_ON) + return true; + return plan_id_enabled; +} + +/* Functions called for plan jumbling or extensions doing their own jumbling */ +extern JumbleState *InitializeJumbleState(bool record_clocations, PlannerGlobal *glob); extern void AppendJumble(JumbleState *jstate, const unsigned char *item, Size size); extern void JumbleNode(JumbleState *jstate, Node *node); extern uint64 HashJumbleState(JumbleState *jstate); diff --git a/src/include/utils/backend_status.h b/src/include/utils/backend_status.h index d3d4ff6c5c9..437a4cec5bf 100644 --- a/src/include/utils/backend_status.h +++ b/src/include/utils/backend_status.h @@ -170,6 +170,9 @@ typedef struct PgBackendStatus /* query identifier, optionally computed using post_parse_analyze_hook */ uint64 st_query_id; + + /* plan identifier, optionally computed after planning */ + uint64 st_plan_id; } PgBackendStatus; @@ -316,6 +319,7 @@ extern void pgstat_clear_backend_activity_snapshot(void); /* Activity reporting functions */ extern void pgstat_report_activity(BackendState state, const char *cmd_str); extern void pgstat_report_query_id(uint64 query_id, bool force); +extern void pgstat_report_plan_id(uint64 query_id, uint64 plan_id, bool force); extern void pgstat_report_tempfile(size_t filesize); extern void pgstat_report_appname(const char *appname); extern void pgstat_report_xact_timestamp(TimestampTz tstamp); @@ -323,6 +327,7 @@ extern const char *pgstat_get_backend_current_activity(int pid, bool checkUser); extern const char *pgstat_get_crashed_backend_activity(int pid, char *buffer, int buflen); extern uint64 pgstat_get_my_query_id(void); +extern uint64 pgstat_get_my_plan_id(void); extern BackendType pgstat_get_backend_type_by_proc_number(ProcNumber procNumber); diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index cddc3ea9b53..d3d5578d2c8 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -889,6 +889,7 @@ CREATE VIEW pg_stat_activity AS S.backend_xid, s.backend_xmin, S.query_id, + S.plan_id, S.query, S.backend_type FROM pg_stat_get_activity(NULL) AS S diff --git a/src/backend/commands/explain.c b/src/backend/commands/explain.c index c24e66f82e1..31a1761f539 100644 --- a/src/backend/commands/explain.c +++ b/src/backend/commands/explain.c @@ -966,6 +966,22 @@ ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc) ExplainPropertyInteger("Query Identifier", NULL, (int64) queryDesc->plannedstmt->queryId, es); } + + /* + * COMPUTE_PLAN_ID_REGRESS means COMPUTE_PLAN_ID_YES, but we don't show + * the queryid in any of the EXPLAIN plans to keep stable the results + * generated by regression test suites. + */ + if (es->verbose && queryDesc->plannedstmt->planId != UINT64CONST(0) && + compute_plan_id != COMPUTE_PLAN_ID_REGRESS) + { + /* + * Output the queryid as an int64 rather than a uint64 so we match + * what would be seen in the BIGINT pg_stat_activity.plan_id column. + */ + ExplainPropertyInteger("Plan Identifier", NULL, (int64) + queryDesc->plannedstmt->planId, es); + } } /* diff --git a/src/backend/executor/execMain.c b/src/backend/executor/execMain.c index 1d27b840ca9..7f16f38f240 100644 --- a/src/backend/executor/execMain.c +++ b/src/backend/executor/execMain.c @@ -120,13 +120,15 @@ ExecutorStart(QueryDesc *queryDesc, int eflags) { /* * In some cases (e.g. an EXECUTE statement or an execute message with the - * extended query protocol) the query_id won't be reported, so do it now. + * extended query protocol) the query_id and plan_id won't be reported, so + * do it now. * - * Note that it's harmless to report the query_id multiple times, as the - * call will be ignored if the top level query_id has already been - * reported. + * Note that it's harmless to report the identifiers multiple times, as + * the call will be ignored if the top level query_id / plan_id has + * already been reported. */ pgstat_report_query_id(queryDesc->plannedstmt->queryId, false); + pgstat_report_plan_id(queryDesc->plannedstmt->planId, queryDesc->plannedstmt->queryId, false); if (ExecutorStart_hook) (*ExecutorStart_hook) (queryDesc, eflags); diff --git a/src/backend/executor/execParallel.c b/src/backend/executor/execParallel.c index 9c313d81315..da2279579a8 100644 --- a/src/backend/executor/execParallel.c +++ b/src/backend/executor/execParallel.c @@ -174,6 +174,7 @@ ExecSerializePlan(Plan *plan, EState *estate) pstmt = makeNode(PlannedStmt); pstmt->commandType = CMD_SELECT; pstmt->queryId = pgstat_get_my_query_id(); + pstmt->planId = pgstat_get_my_plan_id(); pstmt->hasReturning = false; pstmt->hasModifyingCTE = false; pstmt->canSetTag = true; diff --git a/src/backend/nodes/gen_node_support.pl b/src/backend/nodes/gen_node_support.pl index 7c012c27f88..e7b04678e06 100644 --- a/src/backend/nodes/gen_node_support.pl +++ b/src/backend/nodes/gen_node_support.pl @@ -475,6 +475,7 @@ foreach my $infile (@ARGV) equal_ignore_if_zero query_jumble_ignore query_jumble_location + query_jumble_rt_index read_write_ignore write_only_relids write_only_nondefault_pathtarget @@ -1280,13 +1281,19 @@ _jumble${n}(JumbleState *jstate, Node *node) { my $t = $node_type_info{$n}->{field_types}{$f}; my @a = @{ $node_type_info{$n}->{field_attrs}{$f} }; + my $array_size_field; my $query_jumble_ignore = $struct_no_query_jumble; my $query_jumble_location = 0; + my $query_jumble_rt_index = 0; # extract per-field attributes foreach my $a (@a) { - if ($a eq 'query_jumble_ignore') + if ($a =~ /^array_size\(([\w.]+)\)$/) + { + $array_size_field = $1; + } + elsif ($a eq 'query_jumble_ignore') { $query_jumble_ignore = 1; } @@ -1294,10 +1301,29 @@ _jumble${n}(JumbleState *jstate, Node *node) { $query_jumble_location = 1; } + elsif ($a eq 'query_jumble_rt_index') + { + $query_jumble_rt_index = 1; + } } + next if $query_jumble_ignore; + + if ($query_jumble_rt_index) + { + if ($t eq 'List*') + { + print $jff "\tJUMBLE_RT_INDEX_LIST($f);\n" + unless $query_jumble_ignore; + } + else + { + print $jff "\tJUMBLE_RT_INDEX($f);\n" + unless $query_jumble_ignore; + } + } # node type - if (($t =~ /^(\w+)\*$/ or $t =~ /^struct\s+(\w+)\*$/) + elsif (($t =~ /^(\w+)\*$/ or $t =~ /^struct\s+(\w+)\*$/) and elem $1, @node_types) { print $jff "\tJUMBLE_NODE($f);\n" @@ -1317,6 +1343,26 @@ _jumble${n}(JumbleState *jstate, Node *node) print $jff "\tJUMBLE_STRING($f);\n" unless $query_jumble_ignore; } + elsif ($t =~ /^(\w+)(\*|\[\w+\])$/ and elem $1, @scalar_types) + { + if (!defined $array_size_field) + { + die "no array size defined for $n.$f of type $t\n"; + } + if ($node_type_info{$n}->{field_types}{$array_size_field} eq + 'List*') + { + print $jff + "\tJUMBLE_ARRAY($f, list_length(expr->$array_size_field));\n" + unless $query_jumble_ignore; + } + else + { + print $jff + "\tJUMBLE_ARRAY($f, expr->$array_size_field);\n" + unless $query_jumble_ignore; + } + } else { print $jff "\tJUMBLE_FIELD($f);\n" diff --git a/src/backend/nodes/queryjumblefuncs.c b/src/backend/nodes/queryjumblefuncs.c index 545d8edcae2..482d1ea8283 100644 --- a/src/backend/nodes/queryjumblefuncs.c +++ b/src/backend/nodes/queryjumblefuncs.c @@ -35,12 +35,14 @@ #include "common/hashfn.h" #include "miscadmin.h" #include "nodes/queryjumble.h" +#include "parser/parsetree.h" #include "parser/scansup.h" #define JUMBLE_SIZE 1024 /* query serialization buffer size */ /* GUC parameters */ int compute_query_id = COMPUTE_QUERY_ID_AUTO; +int compute_plan_id = COMPUTE_PLAN_ID_AUTO; /* * True when compute_query_id is ON or AUTO, and a module requests them. @@ -51,7 +53,18 @@ int compute_query_id = COMPUTE_QUERY_ID_AUTO; */ bool query_id_enabled = false; +/* + * True when compute_plan_id is ON or AUTO, and a module requests them. + * + * Note that IsPlanIdEnabled() should be used instead of checking + * plan_id_enabled or plan_query_id directly when we want to know + * whether plan identifiers are computed in the core or not. + */ +bool plan_id_enabled = false; + static void RecordConstLocation(JumbleState *jstate, int location); +static void JumbleRangeTableIndex(JumbleState *jstate, Index rti); +static void JumbleRangeTableIndexList(JumbleState *jstate, List *l); static void _jumbleA_Const(JumbleState *jstate, Node *node); static void _jumbleList(JumbleState *jstate, Node *node); static void _jumbleVariableSetStmt(JumbleState *jstate, Node *node); @@ -106,7 +119,7 @@ CleanQuerytext(const char *query, int *location, int *len) } JumbleState * -InitializeJumbleState(bool record_clocations) +InitializeJumbleState(bool record_clocations, PlannerGlobal *glob) { JumbleState *jstate = (JumbleState *) palloc0(sizeof(JumbleState)); @@ -121,6 +134,8 @@ InitializeJumbleState(bool record_clocations) palloc(jstate->clocations_buf_size * sizeof(LocationLen)); } + jstate->glob = glob; + return jstate; } @@ -135,7 +150,7 @@ HashJumbleState(JumbleState *jstate) JumbleState * JumbleQuery(Query *query) { - JumbleState *jstate = InitializeJumbleState(true); + JumbleState *jstate = InitializeJumbleState(true, NULL); Assert(IsQueryIdEnabled()); @@ -171,6 +186,19 @@ EnableQueryId(void) query_id_enabled = true; } +/* + * Enables plan identifier computation. + * + * Third-party plugins can use this function to inform core that they require + * a query identifier to be computed. + */ +void +EnablePlanId(void) +{ + if (compute_plan_id != COMPUTE_PLAN_ID_OFF) + plan_id_enabled = true; +} + /* * AppendJumble: Append a value that is substantive in a given query to * the current jumble. @@ -238,8 +266,17 @@ RecordConstLocation(JumbleState *jstate, int location) JumbleNode(jstate, (Node *) expr->item) #define JUMBLE_LOCATION(location) \ RecordConstLocation(jstate, expr->location) +#define JUMBLE_RT_INDEX(item) \ +do { \ + if (expr->item) \ + JumbleRangeTableIndex(jstate, expr->item); \ +} while(0) +#define JUMBLE_RT_INDEX_LIST(item) \ + JumbleRangeTableIndexList(jstate, expr->item) #define JUMBLE_FIELD(item) \ AppendJumble(jstate, (const unsigned char *) &(expr->item), sizeof(expr->item)) +#define JUMBLE_ARRAY(item, len) \ + AppendJumble(jstate, (const unsigned char *) &(expr->item), sizeof(*(expr->item)) * len) #define JUMBLE_FIELD_SINGLE(item) \ AppendJumble(jstate, (const unsigned char *) &(item), sizeof(item)) #define JUMBLE_STRING(str) \ @@ -388,3 +425,40 @@ _jumbleVariableSetStmt(JumbleState *jstate, Node *node) JUMBLE_FIELD(is_local); JUMBLE_LOCATION(location); } + +/* + * Jumble the target of a rangle table index, e.g. in a Scan or Modify node + */ +static void +JumbleRangeTableIndex(JumbleState *jstate, Index rti) +{ + RangeTblEntry *expr = rt_fetch(rti, jstate->glob->finalrtable); + + switch (expr->rtekind) + { + case RTE_RELATION: + JUMBLE_FIELD(relid); + break; + case RTE_CTE: + JUMBLE_STRING(ctename); + break; + default: + + /* + * Ignore other targets, the jumble includes something identifying + * about them already + */ + break; + } +} + +static void +JumbleRangeTableIndexList(JumbleState *jstate, List *l) +{ + ListCell *lc; + + Assert(l->type == T_IntList); + + foreach(lc, l) + JumbleRangeTableIndex(jstate, lfirst_int(lc)); +} diff --git a/src/backend/optimizer/plan/planner.c b/src/backend/optimizer/plan/planner.c index 8a474a50be7..d14c3218e17 100644 --- a/src/backend/optimizer/plan/planner.c +++ b/src/backend/optimizer/plan/planner.c @@ -37,6 +37,7 @@ #ifdef OPTIMIZER_DEBUG #include "nodes/print.h" #endif +#include "nodes/queryjumble.h" #include "nodes/supportnodes.h" #include "optimizer/appendinfo.h" #include "optimizer/clauses.h" @@ -532,6 +533,16 @@ standard_planner(Query *parse, const char *query_string, int cursorOptions, Assert(glob->finalrowmarks == NIL); Assert(glob->resultRelations == NIL); Assert(glob->appendRelations == NIL); + + /* + * Initialize plan identifier jumble if needed + * + * Note the actual jumbling is done in the tree walk in + * set_plan_references + */ + if (IsPlanIdEnabled()) + glob->plan_jumble_state = InitializeJumbleState(false, glob); + top_plan = set_plan_references(root, top_plan); /* ... and the subplans (both regular subplans and initplans) */ Assert(list_length(glob->subplans) == list_length(glob->subroots)); @@ -571,6 +582,13 @@ standard_planner(Query *parse, const char *query_string, int cursorOptions, result->stmt_location = parse->stmt_location; result->stmt_len = parse->stmt_len; + if (IsPlanIdEnabled()) + { + result->planId = HashJumbleState(glob->plan_jumble_state); + pfree(glob->plan_jumble_state->jumble); + pfree(glob->plan_jumble_state); + } + result->jitFlags = PGJIT_NONE; if (jit_enabled && jit_above_cost >= 0 && top_plan->total_cost > jit_above_cost) diff --git a/src/backend/optimizer/plan/setrefs.c b/src/backend/optimizer/plan/setrefs.c index 0868249be94..fc48337f1df 100644 --- a/src/backend/optimizer/plan/setrefs.c +++ b/src/backend/optimizer/plan/setrefs.c @@ -19,6 +19,7 @@ #include "catalog/pg_type.h" #include "nodes/makefuncs.h" #include "nodes/nodeFuncs.h" +#include "nodes/queryjumble.h" #include "optimizer/optimizer.h" #include "optimizer/pathnode.h" #include "optimizer/planmain.h" @@ -1295,6 +1296,14 @@ set_plan_refs(PlannerInfo *root, Plan *plan, int rtoffset) break; } + /* + * If enabled, append significant information to the plan identifier + * jumble (we do this here since we're already walking the tree in a + * near-final state) + */ + if (IsPlanIdEnabled()) + JumbleNode(root->glob->plan_jumble_state, (Node *) plan); + /* * Now recurse into child plans, if any * diff --git a/src/backend/postmaster/launch_backend.c b/src/backend/postmaster/launch_backend.c index a97a1eda6da..654acf5bf04 100644 --- a/src/backend/postmaster/launch_backend.c +++ b/src/backend/postmaster/launch_backend.c @@ -115,6 +115,7 @@ typedef struct bool redirection_done; bool IsBinaryUpgrade; bool query_id_enabled; + bool plan_id_enabled; int max_safe_fds; int MaxBackends; int num_pmchild_slots; @@ -744,6 +745,7 @@ save_backend_variables(BackendParameters *param, param->redirection_done = redirection_done; param->IsBinaryUpgrade = IsBinaryUpgrade; param->query_id_enabled = query_id_enabled; + param->plan_id_enabled = plan_id_enabled; param->max_safe_fds = max_safe_fds; param->MaxBackends = MaxBackends; @@ -1004,6 +1006,7 @@ restore_backend_variables(BackendParameters *param) redirection_done = param->redirection_done; IsBinaryUpgrade = param->IsBinaryUpgrade; query_id_enabled = param->query_id_enabled; + plan_id_enabled = param->plan_id_enabled; max_safe_fds = param->max_safe_fds; MaxBackends = param->MaxBackends; diff --git a/src/backend/tcop/postgres.c b/src/backend/tcop/postgres.c index 5655348a2e2..6d8947bae9b 100644 --- a/src/backend/tcop/postgres.c +++ b/src/backend/tcop/postgres.c @@ -1106,6 +1106,7 @@ exec_simple_query(const char *query_string) size_t cmdtaglen; pgstat_report_query_id(0, true); + pgstat_report_plan_id(0, 0, true); /* * Get the command name for use in status display (it also becomes the diff --git a/src/backend/utils/activity/backend_status.c b/src/backend/utils/activity/backend_status.c index 731342799a6..1dfb7a58f87 100644 --- a/src/backend/utils/activity/backend_status.c +++ b/src/backend/utils/activity/backend_status.c @@ -379,6 +379,7 @@ pgstat_bestart(void) lbeentry.st_progress_command = PROGRESS_COMMAND_INVALID; lbeentry.st_progress_command_target = InvalidOid; lbeentry.st_query_id = UINT64CONST(0); + lbeentry.st_plan_id = UINT64CONST(0); /* * we don't zero st_progress_param here to save cycles; nobody should @@ -533,6 +534,7 @@ pgstat_report_activity(BackendState state, const char *cmd_str) /* st_xact_start_timestamp and wait_event_info are also disabled */ beentry->st_xact_start_timestamp = 0; beentry->st_query_id = UINT64CONST(0); + beentry->st_plan_id = UINT64CONST(0); proc->wait_event_info = 0; PGSTAT_END_WRITE_ACTIVITY(beentry); } @@ -588,12 +590,15 @@ pgstat_report_activity(BackendState state, const char *cmd_str) beentry->st_state_start_timestamp = current_timestamp; /* - * If a new query is started, we reset the query identifier as it'll only - * be known after parse analysis, to avoid reporting last query's - * identifier. + * If a new query is started, we reset the query and plan identifier as + * it'll only be known after parse analysis / planning, to avoid reporting + * last query's identifiers. */ if (state == STATE_RUNNING) + { beentry->st_query_id = UINT64CONST(0); + beentry->st_plan_id = UINT64CONST(0); + } if (cmd_str != NULL) { @@ -644,6 +649,45 @@ pgstat_report_query_id(uint64 query_id, bool force) PGSTAT_END_WRITE_ACTIVITY(beentry); } +/* -------- + * pgstat_report_plan_id() - + * + * Called to update top-level plan identifier. + * -------- + */ +void +pgstat_report_plan_id(uint64 plan_id, uint64 query_id, bool force) +{ + volatile PgBackendStatus *beentry = MyBEEntry; + + /* + * if track_activities is disabled, st_plan_id should already have been + * reset + */ + if (!beentry || !pgstat_track_activities) + return; + + /* + * We only report the top-level plan identifiers. The stored plan_id is + * reset when a backend calls pgstat_report_activity(STATE_RUNNING), or + * with an explicit call to this function using the force flag. If the + * saved plan identifier is not zero or the query identifier is 0, it + * means that it's not a top-level command, so ignore the one provided + * unless it's an explicit call to reset the identifier. + */ + if ((beentry->st_plan_id != 0 || query_id == 0) && !force) + return; + + /* + * Update my status entry, following the protocol of bumping + * st_changecount before and after. We use a volatile pointer here to + * ensure the compiler doesn't try to get cute. + */ + PGSTAT_BEGIN_WRITE_ACTIVITY(beentry); + beentry->st_plan_id = plan_id; + PGSTAT_END_WRITE_ACTIVITY(beentry); +} + /* ---------- * pgstat_report_appname() - @@ -1040,6 +1084,26 @@ pgstat_get_my_query_id(void) return MyBEEntry->st_query_id; } +/* ---------- + * pgstat_get_my_plan_id() - + * + * Return current backend's plan identifier. + */ +uint64 +pgstat_get_my_plan_id(void) +{ + if (!MyBEEntry) + return 0; + + /* + * There's no need for a lock around pgstat_begin_read_activity / + * pgstat_end_read_activity here as it's only called from + * pg_stat_get_activity which is already protected, or from the same + * backend which means that there won't be concurrent writes. + */ + return MyBEEntry->st_plan_id; +} + /* ---------- * pgstat_get_backend_type_by_proc_number() - * diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c index e9096a88492..a3d5592beb6 100644 --- a/src/backend/utils/adt/pgstatfuncs.c +++ b/src/backend/utils/adt/pgstatfuncs.c @@ -330,7 +330,7 @@ pg_stat_get_progress_info(PG_FUNCTION_ARGS) Datum pg_stat_get_activity(PG_FUNCTION_ARGS) { -#define PG_STAT_GET_ACTIVITY_COLS 31 +#define PG_STAT_GET_ACTIVITY_COLS 32 int num_backends = pgstat_fetch_stat_numbackends(); int curr_backend; int pid = PG_ARGISNULL(0) ? -1 : PG_GETARG_INT32(0); @@ -641,6 +641,10 @@ pg_stat_get_activity(PG_FUNCTION_ARGS) nulls[30] = true; else values[30] = UInt64GetDatum(beentry->st_query_id); + if (beentry->st_plan_id == 0) + nulls[31] = true; + else + values[31] = UInt64GetDatum(beentry->st_plan_id); } else { @@ -670,6 +674,7 @@ pg_stat_get_activity(PG_FUNCTION_ARGS) nulls[28] = true; nulls[29] = true; nulls[30] = true; + nulls[31] = true; } tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, values, nulls); diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c index 38cb9e970d5..9ddb8e97310 100644 --- a/src/backend/utils/misc/guc_tables.c +++ b/src/backend/utils/misc/guc_tables.c @@ -309,6 +309,24 @@ static const struct config_enum_entry compute_query_id_options[] = { {NULL, 0, false} }; +/* + * Although only "on" and "off" are documented, we accept + * all the likely variants of "on" and "off". + */ +static const struct config_enum_entry compute_plan_id_options[] = { + {"auto", COMPUTE_PLAN_ID_AUTO, false}, + {"regress", COMPUTE_PLAN_ID_REGRESS, false}, + {"on", COMPUTE_PLAN_ID_ON, false}, + {"off", COMPUTE_PLAN_ID_OFF, false}, + {"true", COMPUTE_PLAN_ID_ON, true}, + {"false", COMPUTE_PLAN_ID_OFF, true}, + {"yes", COMPUTE_PLAN_ID_ON, true}, + {"no", COMPUTE_PLAN_ID_OFF, true}, + {"1", COMPUTE_PLAN_ID_ON, true}, + {"0", COMPUTE_PLAN_ID_OFF, true}, + {NULL, 0, false} +}; + /* * Although only "on", "off", and "partition" are documented, we * accept all the likely variants of "on" and "off". @@ -4873,6 +4891,16 @@ struct config_enum ConfigureNamesEnum[] = NULL, NULL, NULL }, + { + {"compute_plan_id", PGC_SUSET, STATS_MONITORING, + gettext_noop("Enables in-core computation of plan identifiers."), + NULL + }, + &compute_plan_id, + COMPUTE_PLAN_ID_AUTO, compute_plan_id_options, + NULL, NULL, NULL + }, + { {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER, gettext_noop("Enables the planner to use constraints to optimize queries."), diff --git a/src/backend/utils/misc/postgresql.conf.sample b/src/backend/utils/misc/postgresql.conf.sample index 079efa1baa7..0634ae90dd3 100644 --- a/src/backend/utils/misc/postgresql.conf.sample +++ b/src/backend/utils/misc/postgresql.conf.sample @@ -641,6 +641,7 @@ # - Monitoring - #compute_query_id = auto +#compute_plan_id = auto #log_statement_stats = off #log_parser_stats = off #log_planner_stats = off diff --git a/src/test/regress/expected/explain.out b/src/test/regress/expected/explain.out index ee31e41d508..8bfa3c1a5f9 100644 --- a/src/test/regress/expected/explain.out +++ b/src/test/regress/expected/explain.out @@ -699,6 +699,17 @@ select explain_filter('explain (verbose) create table test_ctas as select 1'); Query Identifier: N (3 rows) +-- Test compute_plan_id +set compute_plan_id = on; +select explain_filter('explain (verbose) select * from int8_tbl i8'); + explain_filter +---------------------------------------------------------------- + Seq Scan on public.int8_tbl i8 (cost=N.N..N.N rows=N width=N) + Output: q1, q2 + Query Identifier: N + Plan Identifier: N +(4 rows) + -- Test SERIALIZE option select explain_filter('explain (analyze,buffers off,serialize) select * from int8_tbl i8'); explain_filter diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 3361f6a69c9..6778b79e658 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1760,9 +1760,10 @@ pg_stat_activity| SELECT s.datid, s.backend_xid, s.backend_xmin, s.query_id, + s.plan_id, s.query, s.backend_type - FROM ((pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id) + FROM ((pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id, plan_id) LEFT JOIN pg_database d ON ((s.datid = d.oid))) LEFT JOIN pg_authid u ON ((s.usesysid = u.oid))); pg_stat_all_indexes| SELECT c.oid AS relid, @@ -1890,7 +1891,7 @@ pg_stat_gssapi| SELECT pid, gss_princ AS principal, gss_enc AS encrypted, gss_delegation AS credentials_delegated - FROM pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id) + FROM pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id, plan_id) WHERE (client_port IS NOT NULL); pg_stat_io| SELECT backend_type, object, @@ -2096,7 +2097,7 @@ pg_stat_replication| SELECT s.pid, w.sync_priority, w.sync_state, w.reply_time - FROM ((pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id) + FROM ((pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id, plan_id) JOIN pg_stat_get_wal_senders() w(pid, state, sent_lsn, write_lsn, flush_lsn, replay_lsn, write_lag, flush_lag, replay_lag, sync_priority, sync_state, reply_time) ON ((s.pid = w.pid))) LEFT JOIN pg_authid u ON ((s.usesysid = u.oid))); pg_stat_replication_slots| SELECT s.slot_name, @@ -2130,7 +2131,7 @@ pg_stat_ssl| SELECT pid, ssl_client_dn AS client_dn, ssl_client_serial AS client_serial, ssl_issuer_dn AS issuer_dn - FROM pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id) + FROM pg_stat_get_activity(NULL::integer) s(datid, pid, usesysid, application_name, state, query, wait_event_type, wait_event, xact_start, query_start, backend_start, state_change, client_addr, client_hostname, client_port, backend_xid, backend_xmin, backend_type, ssl, sslversion, sslcipher, sslbits, ssl_client_dn, ssl_client_serial, ssl_issuer_dn, gss_auth, gss_princ, gss_enc, gss_delegation, leader_pid, query_id, plan_id) WHERE (client_port IS NOT NULL); pg_stat_subscription| SELECT su.oid AS subid, su.subname, diff --git a/src/test/regress/sql/explain.sql b/src/test/regress/sql/explain.sql index 0bafa870496..d787ad2cda3 100644 --- a/src/test/regress/sql/explain.sql +++ b/src/test/regress/sql/explain.sql @@ -167,6 +167,10 @@ select explain_filter('explain (verbose) select * from int8_tbl i8'); select explain_filter('explain (verbose) declare test_cur cursor for select * from int8_tbl'); select explain_filter('explain (verbose) create table test_ctas as select 1'); +-- Test compute_plan_id +set compute_plan_id = on; +select explain_filter('explain (verbose) select * from int8_tbl i8'); + -- Test SERIALIZE option select explain_filter('explain (analyze,buffers off,serialize) select * from int8_tbl i8'); select explain_filter('explain (analyze,serialize text,buffers,timing off) select * from int8_tbl i8'); diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index a782f109982..85a1e0d8d4b 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -8406,6 +8406,40 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; + + compute_plan_id (enum) + + compute_plan_id configuration parameter + + + + + Enables in-core computation of a plan identifier. + Plan identifiers can be displayed in the pg_stat_activity + view or using EXPLAIN. + Note that an external module can alternatively be used if the + in-core plan identifier computation method is not acceptable. + In this case, in-core computation must be always disabled. + Valid values are off (always disabled), + on (always enabled), auto, + which lets modules that utilize plan identifiers enable + it automatically, and regress which + has the same effect as on, except that the + query identifier is not shown in the EXPLAIN output + in order to facilitate automated regression testing. + The default is auto. + + + + To ensure that only one plan identifier is calculated and + displayed, extensions that calculate plan identifiers should + throw an error if a plan identifier has already been computed. + + + + + log_statement_stats (boolean) diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 4e917f159aa..c4ecf20cb2c 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -972,6 +972,22 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser + + + plan_id bigint + + + Identifier of this backend's most recent query plan. If + state is active this + field shows the identifier of the currently executing query plan. In + all other states, it shows the identifier of last query plan that + was executed. Plan identifiers are not computed by default so this + field will be null unless + parameter is enabled or a third-party module that computes plan + identifiers is configured. + + + query text -- 2.47.2