Create hooks to let a loadable plugin monitor (or even replace) the planner

and/or create plans for hypothetical situations; in particular, investigate
plans that would be generated using hypothetical indexes.  This is a
heavily-rewritten version of the hooks proposed by Gurjeet Singh for his
Index Advisor project.  In this formulation, the index advisor can be
entirely a loadable module instead of requiring a significant part to be
in the core backend, and plans can be generated for hypothetical indexes
without requiring the creation and rolling-back of system catalog entries.

The index advisor patch as-submitted is not compatible with these hooks,
but it needs significant work anyway due to other 8.2-to-8.3 planner
changes.  With these hooks in the core backend, development of the advisor
can proceed as a pgfoundry project.

3 files changed, 33 insertions, 5 deletions

diff --git a/src/include/commands/explain.h b/src/include/commands/explain.h
index 42879ce5a40..73bf41e49c1 100644
--- a/src/include/commands/explain.h
+++ b/src/include/commands/explain.h
@@ -6,7 +6,7 @@
  * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994-5, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/commands/explain.h,v 1.30 2007/03/13 00:33:43 tgl Exp $
+ * $PostgreSQL: pgsql/src/include/commands/explain.h,v 1.31 2007/05/25 17:54:25 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -15,6 +15,18 @@
 
 #include "executor/executor.h"
 
+/* Hook for plugins to get control in ExplainOneQuery() */
+typedef void (*ExplainOneQuery_hook_type) (Query *query,
+										   ExplainStmt *stmt,
+										   const char *queryString,
+										   ParamListInfo params,
+										   TupOutputState *tstate);
+extern DLLIMPORT ExplainOneQuery_hook_type ExplainOneQuery_hook;
+
+/* Hook for plugins to get control in explain_get_index_name() */
+typedef const char * (*explain_get_index_name_hook_type) (Oid indexId);
+extern DLLIMPORT explain_get_index_name_hook_type explain_get_index_name_hook;
+
 
 extern void ExplainQuery(ExplainStmt *stmt, const char *queryString,
 						 ParamListInfo params, DestReceiver *dest);
@@ -26,7 +38,7 @@ extern void ExplainOneUtility(Node *utilityStmt, ExplainStmt *stmt,
 							  ParamListInfo params,
 							  TupOutputState *tstate);
 
-extern void ExplainOnePlan(QueryDesc *queryDesc, ExplainStmt *stmt,
-			   TupOutputState *tstate);
+extern void ExplainOnePlan(PlannedStmt *plannedstmt, ParamListInfo params,
+						   ExplainStmt *stmt, TupOutputState *tstate);
 
 #endif   /* EXPLAIN_H */
diff --git a/src/include/optimizer/plancat.h b/src/include/optimizer/plancat.h
index 31391d29a90..a19ba780eed 100644
--- a/src/include/optimizer/plancat.h
+++ b/src/include/optimizer/plancat.h
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/optimizer/plancat.h,v 1.43 2007/01/05 22:19:56 momjian Exp $
+ * $PostgreSQL: pgsql/src/include/optimizer/plancat.h,v 1.44 2007/05/25 17:54:25 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -16,6 +16,13 @@
 
 #include "nodes/relation.h"
 
+/* Hook for plugins to get control in get_relation_info() */
+typedef void (*get_relation_info_hook_type) (PlannerInfo *root,
+											 Oid relationObjectId,
+											 bool inhparent,
+											 RelOptInfo *rel);
+extern DLLIMPORT get_relation_info_hook_type get_relation_info_hook;
+
 
 extern void get_relation_info(PlannerInfo *root, Oid relationObjectId,
 				  bool inhparent, RelOptInfo *rel);
diff --git a/src/include/optimizer/planner.h b/src/include/optimizer/planner.h
index b568a7dbe82..a08a83ae718 100644
--- a/src/include/optimizer/planner.h
+++ b/src/include/optimizer/planner.h
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/optimizer/planner.h,v 1.39 2007/04/16 01:14:58 tgl Exp $
+ * $PostgreSQL: pgsql/src/include/optimizer/planner.h,v 1.40 2007/05/25 17:54:25 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -18,8 +18,17 @@
 #include "nodes/relation.h"
 
 
+/* Hook for plugins to get control in planner() */
+typedef PlannedStmt * (*planner_hook_type) (Query *parse,
+											int cursorOptions,
+											ParamListInfo boundParams);
+extern DLLIMPORT planner_hook_type planner_hook;
+
+
 extern PlannedStmt *planner(Query *parse, int cursorOptions,
 		ParamListInfo boundParams);
+extern PlannedStmt *standard_planner(Query *parse, int cursorOptions,
+		ParamListInfo boundParams);
 extern Plan *subquery_planner(PlannerGlobal *glob, Query *parse,
 							  Index level, double tuple_fraction,
 							  PlannerInfo **subroot);