}
/*
- * ExecSupportsMarkRestore - does a plan type support mark/restore?
+ * ExecSupportsMarkRestore - does a Path support mark/restore?
+ *
+ * This is used during planning and so must accept a Path, not a Plan.
+ * We keep it here to be adjacent to the routines above, which also must
+ * know which plan types support mark/restore.
*
* XXX Ideally, all plan node types would support mark/restore, and this
* wouldn't be needed. For now, this had better match the routines above.
- * But note the test is on Plan nodetype, not PlanState nodetype.
*
* (However, since the only present use of mark/restore is in mergejoin,
* there is no need to support mark/restore in any plan type that is not
bool
ExecSupportsMarkRestore(Path *pathnode)
{
+ /*
+ * For consistency with the routines above, we do not examine the nodeTag
+ * but rather the pathtype, which is the Plan node type the Path would
+ * produce.
+ */
switch (pathnode->pathtype)
{
case T_SeqScan:
case T_Sort:
return true;
+ case T_CustomScan:
+ Assert(IsA(pathnode, CustomPath));
+ if (((CustomPath *) pathnode)->flags & CUSTOMPATH_SUPPORT_MARK_RESTORE)
+ return true;
+ return false;
+
case T_Result:
/*
- * T_Result only supports mark/restore if it has a child plan that
- * does, so we do not have enough information to give a really
- * correct answer. However, for current uses it's enough to
- * always say "false", because this routine is not asked about
- * gating Result plans, only base-case Results.
+ * Although Result supports mark/restore if it has a child plan
+ * that does, we presently come here only for ResultPath nodes,
+ * which represent Result plans without a child plan. So there is
+ * nothing to recurse to and we can just say "false".
*/
+ Assert(IsA(pathnode, ResultPath));
return false;
- case T_CustomScan:
- {
- CustomPath *cpath = (CustomPath *) pathnode;
-
- Assert(IsA(cpath, CustomPath));
- if (cpath->flags & CUSTOMPATH_SUPPORT_MARK_RESTORE)
- return true;
- }
- break;
-
default:
break;
}
case T_CustomScan:
{
- uint32 flags = ((CustomScan *) node)->flags;
+ uint32 flags = ((CustomScan *) node)->flags;
- if (TargetListSupportsBackwardScan(node->targetlist) &&
- (flags & CUSTOMPATH_SUPPORT_BACKWARD_SCAN) != 0)
+ if ((flags & CUSTOMPATH_SUPPORT_BACKWARD_SCAN) &&
+ TargetListSupportsBackwardScan(node->targetlist))
return true;
}
return false;
static ForeignScan *create_foreignscan_plan(PlannerInfo *root, ForeignPath *best_path,
List *tlist, List *scan_clauses);
static Plan *create_customscan_plan(PlannerInfo *root,
- CustomPath *best_path,
- List *tlist, List *scan_clauses);
+ CustomPath *best_path,
+ List *tlist, List *scan_clauses);
static NestLoop *create_nestloop_plan(PlannerInfo *root, NestPath *best_path,
Plan *outer_plan, Plan *inner_plan);
static MergeJoin *create_mergejoin_plan(PlannerInfo *root, MergePath *best_path,
return plan;
}
-/*
- * create_custom_plan
- *
- * Transform a CustomPath into a Plan.
- */
-static Plan *
-create_customscan_plan(PlannerInfo *root, CustomPath *best_path,
- List *tlist, List *scan_clauses)
-{
- Plan *plan;
- RelOptInfo *rel = best_path->path.parent;
-
- /*
- * Right now, all we can support is CustomScan node which is associated
- * with a particular base relation to be scanned.
- */
- Assert(rel && rel->reloptkind == RELOPT_BASEREL);
-
- /*
- * Sort clauses into the best execution order, although custom-scan
- * provider can reorder them again.
- */
- scan_clauses = order_qual_clauses(root, scan_clauses);
-
- /*
- * Create a CustomScan (or its inheritance) node according to
- * the supplied CustomPath.
- */
- plan = best_path->methods->PlanCustomPath(root, rel, best_path, tlist,
- scan_clauses);
-
- /*
- * NOTE: unlike create_foreignscan_plan(), it is responsibility of
- * the custom plan provider to replace outer-relation variables
- * with nestloop params, because we cannot know how many expression
- * trees are held in the private fields.
- */
-
- /*
- * Copy cost data from Path to Plan; no need to make custom-plan
- * providers do this
- */
- copy_path_costsize(plan, &best_path->path);
-
- return plan;
-}
/*****************************************************************************
*
return scan_plan;
}
+/*
+ * create_custom_plan
+ *
+ * Transform a CustomPath into a Plan.
+ */
+static Plan *
+create_customscan_plan(PlannerInfo *root, CustomPath *best_path,
+ List *tlist, List *scan_clauses)
+{
+ Plan *plan;
+ RelOptInfo *rel = best_path->path.parent;
+
+ /*
+ * Right now, all we can support is CustomScan node which is associated
+ * with a particular base relation to be scanned.
+ */
+ Assert(rel && rel->reloptkind == RELOPT_BASEREL);
+
+ /*
+ * Sort clauses into the best execution order, although custom-scan
+ * provider can reorder them again.
+ */
+ scan_clauses = order_qual_clauses(root, scan_clauses);
+
+ /*
+ * Invoke custom plan provider to create the Plan node represented by the
+ * CustomPath.
+ */
+ plan = best_path->methods->PlanCustomPath(root, rel, best_path, tlist,
+ scan_clauses);
+
+ /*
+ * NOTE: unlike create_foreignscan_plan(), it is the responsibility of the
+ * custom plan provider to replace outer-relation variables with nestloop
+ * params, because we cannot know what expression trees may be held in
+ * private fields.
+ */
+
+ /*
+ * Copy cost data from Path to Plan; no need to make custom-plan providers
+ * do this
+ */
+ copy_path_costsize(plan, &best_path->path);
+
+ return plan;
+}
+
/*****************************************************************************
*
fix_scan_list(root, cscan->scan.plan.targetlist, rtoffset);
cscan->scan.plan.qual =
fix_scan_list(root, cscan->scan.plan.qual, rtoffset);
+
/*
- * The core implementation applies the routine to fixup
- * varno on the target-list and scan qualifier.
- * If custom-scan has additional expression nodes on its
- * private fields, it has to apply same fixup on them.
- * Otherwise, the custom-plan provider can skip this callback.
+ * The core implementation applies the routine to fixup varno
+ * on the target-list and scan qualifier. If custom-scan has
+ * additional expression nodes on its private fields, it has
+ * to apply same fixup on them. Otherwise, the custom-plan
+ * provider can skip this callback.
*/
if (cscan->methods->SetCustomScanRef)
cscan->methods->SetCustomScanRef(root, cscan, rtoffset);
* We assume it's okay to update opcode info in-place. So this could possibly
* scribble on the planner's input data structures, but it's OK.
*/
-void
+static void
fix_expr_common(PlannerInfo *root, Node *node)
{
/* We assume callers won't call us on a NULL pointer */
}
/*****************************************************************************
- * creation of custom-plan paths
+ * creation of custom-plan paths
*****************************************************************************/
-static List *custom_path_providers = NIL;
+static List *custom_path_providers = NIL;
/*
* register_custom_path_provider
* methods of scanning a relation.
*/
void
-register_custom_path_provider(CustomPathMethods *cpp_methods)
+register_custom_path_provider(const CustomPathMethods *cpp_methods)
{
- MemoryContext oldcxt;
+ MemoryContext oldcxt;
oldcxt = MemoryContextSwitchTo(TopMemoryContext);
- custom_path_providers = lappend(custom_path_providers, cpp_methods);
+ custom_path_providers = lappend(custom_path_providers,
+ (void *) cpp_methods);
MemoryContextSwitchTo(oldcxt);
}
RelOptInfo *baserel,
RangeTblEntry *rte)
{
- ListCell *cell;
+ ListCell *cell;
- foreach (cell, custom_path_providers)
+ foreach(cell, custom_path_providers)
{
const CustomPathMethods *cpp_methods = lfirst(cell);
#include "executor/execdesc.h"
#include "nodes/parsenodes.h"
-#include "nodes/relation.h"
#include "utils/lockwaitpolicy.h"
/*
* prototypes from functions in execAmi.c
*/
+struct Path; /* avoid including relation.h here */
+
extern void ExecReScan(PlanState *node);
extern void ExecMarkPos(PlanState *node);
extern void ExecRestrPos(PlanState *node);
-extern bool ExecSupportsMarkRestore(Path *pathnode);
+extern bool ExecSupportsMarkRestore(struct Path *pathnode);
extern bool ExecSupportsBackwardScan(Plan *node);
extern bool ExecMaterializesOutput(NodeTag plantype);
*/
#ifndef NODECUSTOM_H
#define NODECUSTOM_H
-#include "nodes/plannodes.h"
+
#include "nodes/execnodes.h"
/*
* General executor code
*/
extern CustomScanState *ExecInitCustomScan(CustomScan *custom_scan,
- EState *estate, int eflags);
+ EState *estate, int eflags);
extern TupleTableSlot *ExecCustomScan(CustomScanState *node);
extern Node *MultiExecCustomScan(CustomScanState *node);
extern void ExecEndCustomScan(CustomScanState *node);
extern void ExecCustomMarkPos(CustomScanState *node);
extern void ExecCustomRestrPos(CustomScanState *node);
-#endif /* NODECUSTOM_H */
+#endif /* NODECUSTOM_H */
#include "executor/instrument.h"
#include "nodes/params.h"
#include "nodes/plannodes.h"
-#include "nodes/relation.h"
#include "utils/reltrigger.h"
#include "utils/sortsupport.h"
#include "utils/tuplestore.h"
* CustomScan nodes are used to execute custom code within executor.
* ----------------
*/
-struct CustomExecMethods;
-struct ExplainState; /* to avoid to include explain.h here */
-
-typedef struct CustomScanState
-{
- ScanState ss;
- uint32 flags; /* mask of CUSTOMPATH_* flags defined in relation.h*/
- const struct CustomExecMethods *methods;
-} CustomScanState;
+struct ExplainState; /* avoid including explain.h here */
+struct CustomScanState;
typedef struct CustomExecMethods
{
- const char *CustomName;
+ const char *CustomName;
/* EXECUTOR methods */
- void (*BeginCustomScan)(CustomScanState *node,
- EState *estate,
- int eflags);
- TupleTableSlot *(*ExecCustomScan)(CustomScanState *node);
- void (*EndCustomScan)(CustomScanState *node);
- void (*ReScanCustomScan)(CustomScanState *node);
- void (*MarkPosCustomScan)(CustomScanState *node);
- void (*RestrPosCustomScan)(CustomScanState *node);
+ void (*BeginCustomScan) (struct CustomScanState *node,
+ EState *estate,
+ int eflags);
+ TupleTableSlot *(*ExecCustomScan) (struct CustomScanState *node);
+ void (*EndCustomScan) (struct CustomScanState *node);
+ void (*ReScanCustomScan) (struct CustomScanState *node);
+ void (*MarkPosCustomScan) (struct CustomScanState *node);
+ void (*RestrPosCustomScan) (struct CustomScanState *node);
/* EXPLAIN support */
- void (*ExplainCustomScan)(CustomScanState *node,
- List *ancestors,
- struct ExplainState *es);
- Node *(*GetSpecialCustomVar)(CustomScanState *node,
- Var *varnode,
- PlanState **child_ps);
+ void (*ExplainCustomScan) (struct CustomScanState *node,
+ List *ancestors,
+ struct ExplainState *es);
+ Node *(*GetSpecialCustomVar) (struct CustomScanState *node,
+ Var *varnode,
+ PlanState **child_ps);
} CustomExecMethods;
+typedef struct CustomScanState
+{
+ ScanState ss;
+ uint32 flags; /* mask of CUSTOMPATH_* flags, see relation.h */
+ const CustomExecMethods *methods;
+} CustomScanState;
+
/* ----------------------------------------------------------------
* Join State Information
* ----------------------------------------------------------------
#include "lib/stringinfo.h"
#include "nodes/bitmapset.h"
#include "nodes/primnodes.h"
-#include "nodes/relation.h"
#include "utils/lockwaitpolicy.h"
} ForeignScan;
/* ----------------
- * CustomScan node
+ * CustomScan node
* ----------------
*/
-struct CustomScanMethods;
-
-typedef struct CustomScan
-{
- Scan scan;
- uint32 flags; /* mask of CUSTOMPATH_* flags defined in relation.h */
- struct CustomScanMethods *methods;
-} CustomScan;
+struct PlannerInfo; /* avoid including relation.h here */
+struct CustomScan;
typedef struct CustomScanMethods
{
const char *CustomName;
- void (*SetCustomScanRef)(struct PlannerInfo *root,
- CustomScan *cscan,
- int rtoffset);
- void (*FinalizeCustomScan)(struct PlannerInfo *root,
- CustomScan *cscan,
- bool (*finalize_primnode)(),
- void *finalize_context);
- Node *(*CreateCustomScanState)(CustomScan *cscan);
- void (*TextOutCustomScan)(StringInfo str, const CustomScan *node);
- CustomScan *(*CopyCustomScan)(const CustomScan *from);
+
+ void (*SetCustomScanRef) (struct PlannerInfo *root,
+ struct CustomScan *cscan,
+ int rtoffset);
+ void (*FinalizeCustomScan) (struct PlannerInfo *root,
+ struct CustomScan *cscan,
+ bool (*finalize_primnode) (),
+ void *finalize_context);
+ Node *(*CreateCustomScanState) (struct CustomScan *cscan);
+ void (*TextOutCustomScan) (StringInfo str,
+ const struct CustomScan *node);
+ struct CustomScan *(*CopyCustomScan) (const struct CustomScan *from);
} CustomScanMethods;
+typedef struct CustomScan
+{
+ Scan scan;
+ uint32 flags; /* mask of CUSTOMPATH_* flags, see relation.h */
+ const CustomScanMethods *methods;
+} CustomScan;
+
/*
* ==========
* Join nodes
Index prti; /* range table index of parent relation */
Index rowmarkId; /* unique identifier for resjunk columns */
RowMarkType markType; /* see enum above */
- LockWaitPolicy waitPolicy; /* NOWAIT and SKIP LOCKED options */
+ LockWaitPolicy waitPolicy; /* NOWAIT and SKIP LOCKED options */
bool isParent; /* true if this is a "dummy" parent entry */
} PlanRowMark;
* the structure declared here; providers are expected to make it the first
* element in a larger structure.
*/
-
-struct CustomPathMethods;
-struct Plan; /* not to include plannodes.h here */
+struct CustomPath;
#define CUSTOMPATH_SUPPORT_BACKWARD_SCAN 0x0001
#define CUSTOMPATH_SUPPORT_MARK_RESTORE 0x0002
-typedef struct CustomPath
-{
- Path path;
- uint32 flags;
- const struct CustomPathMethods *methods;
-} CustomPath;
-
typedef struct CustomPathMethods
{
const char *CustomName;
- void (*CreateCustomScanPath)(PlannerInfo *root,
- RelOptInfo *baserel,
- RangeTblEntry *rte);
- struct Plan *(*PlanCustomPath)(PlannerInfo *root,
- RelOptInfo *rel,
- CustomPath *best_path,
- List *tlist,
- List *clauses);
- void (*TextOutCustomPath)(StringInfo str, const CustomPath *node);
+
+ void (*CreateCustomScanPath) (PlannerInfo *root,
+ RelOptInfo *baserel,
+ RangeTblEntry *rte);
+ struct Plan *(*PlanCustomPath) (PlannerInfo *root,
+ RelOptInfo *rel,
+ struct CustomPath *best_path,
+ List *tlist,
+ List *clauses);
+ void (*TextOutCustomPath) (StringInfo str,
+ const struct CustomPath *node);
} CustomPathMethods;
+typedef struct CustomPath
+{
+ Path path;
+ uint32 flags; /* mask of CUSTOMPATH_* flags, see above */
+ const CustomPathMethods *methods;
+} CustomPath;
+
/*
* AppendPath represents an Append plan, ie, successive execution of
* several member plans.
/*
* Interface definition of custom-scan providers
*/
-extern void register_custom_path_provider(CustomPathMethods *cpp_methods);
+extern void register_custom_path_provider(const CustomPathMethods *cpp_methods);
extern void create_customscan_paths(PlannerInfo *root,
- RelOptInfo *baserel,
- RangeTblEntry *rte);
+ RelOptInfo *baserel,
+ RangeTblEntry *rte);
/*
* prototypes for relnode.c
* prototypes for plan/setrefs.c
*/
extern Plan *set_plan_references(PlannerInfo *root, Plan *plan);
-extern void fix_opfuncids(Node *node);
extern Node *fix_scan_expr(PlannerInfo *root, Node *node, int rtoffset);
-extern void fix_expr_common(PlannerInfo *root, Node *node);
+extern void fix_opfuncids(Node *node);
extern void set_opfuncid(OpExpr *opexpr);
extern void set_sa_opfuncid(ScalarArrayOpExpr *opexpr);
extern void record_plan_function_dependency(PlannerInfo *root, Oid funcid);
projects / postgresql.git / commitdiff