nodeCustom.h File Reference

#include "access/parallel.h"
#include "nodes/execnodes.h"

Include dependency graph for nodeCustom.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
CustomScanState *	ExecInitCustomScan (CustomScan *cscan, EState *estate, int eflags)
void	ExecEndCustomScan (CustomScanState *node)
void	ExecReScanCustomScan (CustomScanState *node)
void	ExecCustomMarkPos (CustomScanState *node)
void	ExecCustomRestrPos (CustomScanState *node)
void	ExecCustomScanEstimate (CustomScanState *node, ParallelContext *pcxt)
void	ExecCustomScanInitializeDSM (CustomScanState *node, ParallelContext *pcxt)
void	ExecCustomScanReInitializeDSM (CustomScanState *node, ParallelContext *pcxt)
void	ExecCustomScanInitializeWorker (CustomScanState *node, ParallelWorkerContext *pwcxt)
void	ExecShutdownCustomScan (CustomScanState *node)

Function Documentation

ExecCustomMarkPos()

void ExecCustomMarkPos

(

CustomScanState *

node

)

Definition at line 139 of file nodeCustom.c.

{
    if (!node->methods->MarkPosCustomScan)
        ereport(ERROR,
                (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                 errmsg("custom scan \"%s\" does not support MarkPos",
                        node->methods->CustomName)));
    node->methods->MarkPosCustomScan(node);
}

References CustomExecMethods::CustomName, ereport, errcode(), errmsg(), ERROR, CustomExecMethods::MarkPosCustomScan, and CustomScanState::methods.

Referenced by ExecMarkPos().

ExecCustomRestrPos()

void ExecCustomRestrPos

(

CustomScanState *

node

)

Definition at line 150 of file nodeCustom.c.

{
    if (!node->methods->RestrPosCustomScan)
        ereport(ERROR,
                (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                 errmsg("custom scan \"%s\" does not support MarkPos",
                        node->methods->CustomName)));
    node->methods->RestrPosCustomScan(node);
}

References CustomExecMethods::CustomName, ereport, errcode(), errmsg(), ERROR, CustomScanState::methods, and CustomExecMethods::RestrPosCustomScan.

Referenced by ExecRestrPos().

ExecCustomScanEstimate()

void ExecCustomScanEstimate	(	CustomScanState *	node,
		ParallelContext *	pcxt
	)

Definition at line 161 of file nodeCustom.c.

{
    const CustomExecMethods *methods = node->methods;
 
    if (methods->EstimateDSMCustomScan)
    {
        node->pscan_len = methods->EstimateDSMCustomScan(node, pcxt);
        shm_toc_estimate_chunk(&pcxt->estimator, node->pscan_len);
        shm_toc_estimate_keys(&pcxt->estimator, 1);
    }
}

References CustomExecMethods::EstimateDSMCustomScan, ParallelContext::estimator, CustomScanState::methods, CustomScanState::pscan_len, shm_toc_estimate_chunk, and shm_toc_estimate_keys.

Referenced by ExecParallelEstimate().

ExecCustomScanInitializeDSM()

void ExecCustomScanInitializeDSM	(	CustomScanState *	node,
		ParallelContext *	pcxt
	)

Definition at line 174 of file nodeCustom.c.

{
    const CustomExecMethods *methods = node->methods;
 
    if (methods->InitializeDSMCustomScan)
    {
        int         plan_node_id = node->ss.ps.plan->plan_node_id;
        void       *coordinate;
 
        coordinate = shm_toc_allocate(pcxt->toc, node->pscan_len);
        methods->InitializeDSMCustomScan(node, pcxt, coordinate);
        shm_toc_insert(pcxt->toc, plan_node_id, coordinate);
    }
}

References CustomExecMethods::InitializeDSMCustomScan, CustomScanState::methods, PlanState::plan, Plan::plan_node_id, ScanState::ps, CustomScanState::pscan_len, shm_toc_allocate(), shm_toc_insert(), CustomScanState::ss, and ParallelContext::toc.

Referenced by ExecParallelInitializeDSM().

ExecCustomScanInitializeWorker()

void ExecCustomScanInitializeWorker	(	CustomScanState *	node,
		ParallelWorkerContext *	pwcxt
	)

Definition at line 205 of file nodeCustom.c.

{
    const CustomExecMethods *methods = node->methods;
 
    if (methods->InitializeWorkerCustomScan)
    {
        int         plan_node_id = node->ss.ps.plan->plan_node_id;
        void       *coordinate;
 
        coordinate = shm_toc_lookup(pwcxt->toc, plan_node_id, false);
        methods->InitializeWorkerCustomScan(node, pwcxt->toc, coordinate);
    }
}

References CustomExecMethods::InitializeWorkerCustomScan, CustomScanState::methods, PlanState::plan, Plan::plan_node_id, ScanState::ps, shm_toc_lookup(), CustomScanState::ss, and ParallelWorkerContext::toc.

Referenced by ExecParallelInitializeWorker().

ExecCustomScanReInitializeDSM()

void ExecCustomScanReInitializeDSM	(	CustomScanState *	node,
		ParallelContext *	pcxt
	)

Definition at line 190 of file nodeCustom.c.

{
    const CustomExecMethods *methods = node->methods;
 
    if (methods->ReInitializeDSMCustomScan)
    {
        int         plan_node_id = node->ss.ps.plan->plan_node_id;
        void       *coordinate;
 
        coordinate = shm_toc_lookup(pcxt->toc, plan_node_id, false);
        methods->ReInitializeDSMCustomScan(node, pcxt, coordinate);
    }
}

References CustomScanState::methods, PlanState::plan, Plan::plan_node_id, ScanState::ps, CustomExecMethods::ReInitializeDSMCustomScan, shm_toc_lookup(), CustomScanState::ss, and ParallelContext::toc.

Referenced by ExecParallelReInitializeDSM().

ExecEndCustomScan()

void ExecEndCustomScan

(

CustomScanState *

node

)

Definition at line 125 of file nodeCustom.c.

{
    Assert(node->methods->EndCustomScan != NULL);
    node->methods->EndCustomScan(node);
}

References Assert, CustomExecMethods::EndCustomScan, and CustomScanState::methods.

Referenced by ExecEndNode().

ExecInitCustomScan()

CustomScanState* ExecInitCustomScan	(	CustomScan *	cscan,
		EState *	estate,
		int	eflags
	)

Definition at line 26 of file nodeCustom.c.

{
    CustomScanState *css;
    const TupleTableSlotOps *slotOps;
    Relation    scan_rel = NULL;
    Index       scanrelid = cscan->scan.scanrelid;
    int         tlistvarno;
 
    /*
     * Allocate the CustomScanState object.  We let the custom scan provider
     * do the palloc, in case it wants to make a larger object that embeds
     * CustomScanState as the first field.  It must set the node tag and the
     * methods field correctly at this time.  Other standard fields should be
     * set to zero.
     */
    css = castNode(CustomScanState,
                   cscan->methods->CreateCustomScanState(cscan));
 
    /* ensure flags is filled correctly */
    css->flags = cscan->flags;
 
    /* fill up fields of ScanState */
    css->ss.ps.plan = &cscan->scan.plan;
    css->ss.ps.state = estate;
    css->ss.ps.ExecProcNode = ExecCustomScan;
 
    /* create expression context for node */
    ExecAssignExprContext(estate, &css->ss.ps);
 
    /*
     * open the scan relation, if any
     */
    if (scanrelid > 0)
    {
        scan_rel = ExecOpenScanRelation(estate, scanrelid, eflags);
        css->ss.ss_currentRelation = scan_rel;
    }
 
    /*
     * Use a custom slot if specified in CustomScanState or use virtual slot
     * otherwise.
     */
    slotOps = css->slotOps;
    if (!slotOps)
        slotOps = &TTSOpsVirtual;
 
    /*
     * Determine the scan tuple type.  If the custom scan provider provided a
     * targetlist describing the scan tuples, use that; else use base
     * relation's rowtype.
     */
    if (cscan->custom_scan_tlist != NIL || scan_rel == NULL)
    {
        TupleDesc   scan_tupdesc;
 
        scan_tupdesc = ExecTypeFromTL(cscan->custom_scan_tlist);
        ExecInitScanTupleSlot(estate, &css->ss, scan_tupdesc, slotOps);
        /* Node's targetlist will contain Vars with varno = INDEX_VAR */
        tlistvarno = INDEX_VAR;
    }
    else
    {
        ExecInitScanTupleSlot(estate, &css->ss, RelationGetDescr(scan_rel),
                              slotOps);
        /* Node's targetlist will contain Vars with varno = scanrelid */
        tlistvarno = scanrelid;
    }
 
    /*
     * Initialize result slot, type and projection.
     */
    ExecInitResultTupleSlotTL(&css->ss.ps, &TTSOpsVirtual);
    ExecAssignScanProjectionInfoWithVarno(&css->ss, tlistvarno);
 
    /* initialize child expressions */
    css->ss.ps.qual =
        ExecInitQual(cscan->scan.plan.qual, (PlanState *) css);
 
    /*
     * The callback of custom-scan provider applies the final initialization
     * of the custom-scan-state node according to its logic.
     */
    css->methods->BeginCustomScan(css, estate, eflags);
 
    return css;
}

References CustomExecMethods::BeginCustomScan, castNode, CustomScanMethods::CreateCustomScanState, CustomScan::custom_scan_tlist, ExecAssignExprContext(), ExecAssignScanProjectionInfoWithVarno(), ExecCustomScan(), ExecInitQual(), ExecInitResultTupleSlotTL(), ExecInitScanTupleSlot(), ExecOpenScanRelation(), PlanState::ExecProcNode, ExecTypeFromTL(), CustomScanState::flags, CustomScan::flags, INDEX_VAR, CustomScanState::methods, CustomScan::methods, NIL, PlanState::plan, ScanState::ps, PlanState::qual, RelationGetDescr, CustomScan::scan, Scan::scanrelid, CustomScanState::slotOps, CustomScanState::ss, ScanState::ss_currentRelation, PlanState::state, and TTSOpsVirtual.

Referenced by ExecInitNode().

ExecReScanCustomScan()

void ExecReScanCustomScan

(

CustomScanState *

node

)

Definition at line 132 of file nodeCustom.c.

{
    Assert(node->methods->ReScanCustomScan != NULL);
    node->methods->ReScanCustomScan(node);
}

References Assert, CustomScanState::methods, and CustomExecMethods::ReScanCustomScan.

Referenced by ExecReScan().

ExecShutdownCustomScan()

void ExecShutdownCustomScan

(

CustomScanState *

node

)

Definition at line 221 of file nodeCustom.c.

{
    const CustomExecMethods *methods = node->methods;
 
    if (methods->ShutdownCustomScan)
        methods->ShutdownCustomScan(node);
}

References CustomScanState::methods, and CustomExecMethods::ShutdownCustomScan.

Referenced by ExecShutdownNode_walker().