granicus.if.org Git - postgresql/blob - src/include/nodes/execnodes.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * execnodes.h
   4  *        definitions for executor state nodes
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL: pgsql/src/include/nodes/execnodes.h,v 1.215 2010/01/01 23:03:10 tgl Exp $
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef EXECNODES_H
  15 #define EXECNODES_H
  16
  17 #include "access/genam.h"
  18 #include "access/heapam.h"
  19 #include "access/skey.h"
  20 #include "nodes/params.h"
  21 #include "nodes/plannodes.h"
  22 #include "nodes/tidbitmap.h"
  23 #include "utils/hsearch.h"
  24 #include "utils/rel.h"
  25 #include "utils/snapshot.h"
  26 #include "utils/tuplestore.h"
  27
  28
  29 /* ----------------
  30  *        IndexInfo information
  31  *
  32  *              this struct holds the information needed to construct new index
  33  *              entries for a particular index.  Used for both index_build and
  34  *              retail creation of index entries.
  35  *
  36  *              NumIndexAttrs           number of columns in this index
  37  *              KeyAttrNumbers          underlying-rel attribute numbers used as keys
  38  *                                                      (zeroes indicate expressions)
  39  *              Expressions                     expr trees for expression entries, or NIL if none
  40  *              ExpressionsState        exec state for expressions, or NIL if none
  41  *              Predicate                       partial-index predicate, or NIL if none
  42  *              PredicateState          exec state for predicate, or NIL if none
  43  *              ExclusionOps            Per-column exclusion operators, or NULL if none
  44  *              ExclusionProcs          Underlying function OIDs for ExclusionOps
  45  *              ExclusionStrats         Opclass strategy numbers for ExclusionOps
  46  *              Unique                          is it a unique index?
  47  *              ReadyForInserts         is it valid for inserts?
  48  *              Concurrent                      are we doing a concurrent index build?
  49  *              BrokenHotChain          did we detect any broken HOT chains?
  50  *
  51  * ii_Concurrent and ii_BrokenHotChain are used only during index build;
  52  * they're conventionally set to false otherwise.
  53  * ----------------
  54  */
  55 typedef struct IndexInfo
  56 {
  57         NodeTag         type;
  58         int                     ii_NumIndexAttrs;
  59         AttrNumber      ii_KeyAttrNumbers[INDEX_MAX_KEYS];
  60         List       *ii_Expressions; /* list of Expr */
  61         List       *ii_ExpressionsState;        /* list of ExprState */
  62         List       *ii_Predicate;       /* list of Expr */
  63         List       *ii_PredicateState;          /* list of ExprState */
  64         Oid                *ii_ExclusionOps;            /* array with one entry per column */
  65         Oid                *ii_ExclusionProcs;          /* array with one entry per column */
  66         uint16     *ii_ExclusionStrats;         /* array with one entry per column */
  67         bool            ii_Unique;
  68         bool            ii_ReadyForInserts;
  69         bool            ii_Concurrent;
  70         bool            ii_BrokenHotChain;
  71 } IndexInfo;
  72
  73 /* ----------------
  74  *        ExprContext_CB
  75  *
  76  *              List of callbacks to be called at ExprContext shutdown.
  77  * ----------------
  78  */
  79 typedef void (*ExprContextCallbackFunction) (Datum arg);
  80
  81 typedef struct ExprContext_CB
  82 {
  83         struct ExprContext_CB *next;
  84         ExprContextCallbackFunction function;
  85         Datum           arg;
  86 } ExprContext_CB;
  87
  88 /* ----------------
  89  *        ExprContext
  90  *
  91  *              This class holds the "current context" information
  92  *              needed to evaluate expressions for doing tuple qualifications
  93  *              and tuple projections.  For example, if an expression refers
  94  *              to an attribute in the current inner tuple then we need to know
  95  *              what the current inner tuple is and so we look at the expression
  96  *              context.
  97  *
  98  *      There are two memory contexts associated with an ExprContext:
  99  *      * ecxt_per_query_memory is a query-lifespan context, typically the same
 100  *        context the ExprContext node itself is allocated in.  This context
 101  *        can be used for purposes such as storing function call cache info.
 102  *      * ecxt_per_tuple_memory is a short-term context for expression results.
 103  *        As the name suggests, it will typically be reset once per tuple,
 104  *        before we begin to evaluate expressions for that tuple.  Each
 105  *        ExprContext normally has its very own per-tuple memory context.
 106  *
 107  *      CurrentMemoryContext should be set to ecxt_per_tuple_memory before
 108  *      calling ExecEvalExpr() --- see ExecEvalExprSwitchContext().
 109  * ----------------
 110  */
 111 typedef struct ExprContext
 112 {
 113         NodeTag         type;
 114
 115         /* Tuples that Var nodes in expression may refer to */
 116         TupleTableSlot *ecxt_scantuple;
 117         TupleTableSlot *ecxt_innertuple;
 118         TupleTableSlot *ecxt_outertuple;
 119
 120         /* Memory contexts for expression evaluation --- see notes above */
 121         MemoryContext ecxt_per_query_memory;
 122         MemoryContext ecxt_per_tuple_memory;
 123
 124         /* Values to substitute for Param nodes in expression */
 125         ParamExecData *ecxt_param_exec_vals;            /* for PARAM_EXEC params */
 126         ParamListInfo ecxt_param_list_info; /* for other param types */
 127
 128         /*
 129          * Values to substitute for Aggref nodes in the expressions of an Agg
 130          * node, or for WindowFunc nodes within a WindowAgg node.
 131          */
 132         Datum      *ecxt_aggvalues; /* precomputed values for aggs/windowfuncs */
 133         bool       *ecxt_aggnulls;      /* null flags for aggs/windowfuncs */
 134
 135         /* Value to substitute for CaseTestExpr nodes in expression */
 136         Datum           caseValue_datum;
 137         bool            caseValue_isNull;
 138
 139         /* Value to substitute for CoerceToDomainValue nodes in expression */
 140         Datum           domainValue_datum;
 141         bool            domainValue_isNull;
 142
 143         /* Link to containing EState (NULL if a standalone ExprContext) */
 144         struct EState *ecxt_estate;
 145
 146         /* Functions to call back when ExprContext is shut down */
 147         ExprContext_CB *ecxt_callbacks;
 148 } ExprContext;
 149
 150 /*
 151  * Set-result status returned by ExecEvalExpr()
 152  */
 153 typedef enum
 154 {
 155         ExprSingleResult,                       /* expression does not return a set */
 156         ExprMultipleResult,                     /* this result is an element of a set */
 157         ExprEndResult                           /* there are no more elements in the set */
 158 } ExprDoneCond;
 159
 160 /*
 161  * Return modes for functions returning sets.  Note values must be chosen
 162  * as separate bits so that a bitmask can be formed to indicate supported
 163  * modes.  SFRM_Materialize_Random and SFRM_Materialize_Preferred are
 164  * auxiliary flags about SFRM_Materialize mode, rather than separate modes.
 165  */
 166 typedef enum
 167 {
 168         SFRM_ValuePerCall = 0x01,       /* one value returned per call */
 169         SFRM_Materialize = 0x02,        /* result set instantiated in Tuplestore */
 170         SFRM_Materialize_Random = 0x04,         /* Tuplestore needs randomAccess */
 171         SFRM_Materialize_Preferred = 0x08       /* caller prefers Tuplestore */
 172 } SetFunctionReturnMode;
 173
 174 /*
 175  * When calling a function that might return a set (multiple rows),
 176  * a node of this type is passed as fcinfo->resultinfo to allow
 177  * return status to be passed back.  A function returning set should
 178  * raise an error if no such resultinfo is provided.
 179  */
 180 typedef struct ReturnSetInfo
 181 {
 182         NodeTag         type;
 183         /* values set by caller: */
 184         ExprContext *econtext;          /* context function is being called in */
 185         TupleDesc       expectedDesc;   /* tuple descriptor expected by caller */
 186         int                     allowedModes;   /* bitmask: return modes caller can handle */
 187         /* result status from function (but pre-initialized by caller): */
 188         SetFunctionReturnMode returnMode;       /* actual return mode */
 189         ExprDoneCond isDone;            /* status for ValuePerCall mode */
 190         /* fields filled by function in Materialize return mode: */
 191         Tuplestorestate *setResult; /* holds the complete returned tuple set */
 192         TupleDesc       setDesc;                /* actual descriptor for returned tuples */
 193 } ReturnSetInfo;
 194
 195 /* ----------------
 196  *              ProjectionInfo node information
 197  *
 198  *              This is all the information needed to perform projections ---
 199  *              that is, form new tuples by evaluation of targetlist expressions.
 200  *              Nodes which need to do projections create one of these.
 201  *
 202  *              ExecProject() evaluates the tlist, forms a tuple, and stores it
 203  *              in the given slot.      Note that the result will be a "virtual" tuple
 204  *              unless ExecMaterializeSlot() is then called to force it to be
 205  *              converted to a physical tuple.  The slot must have a tupledesc
 206  *              that matches the output of the tlist!
 207  *
 208  *              The planner very often produces tlists that consist entirely of
 209  *              simple Var references (lower levels of a plan tree almost always
 210  *              look like that).  And top-level tlists are often mostly Vars too.
 211  *              We therefore optimize execution of simple-Var tlist entries.
 212  *              The pi_targetlist list actually contains only the tlist entries that
 213  *              aren't simple Vars, while those that are Vars are processed using the
 214  *              varSlotOffsets/varNumbers/varOutputCols arrays.
 215  *
 216  *              The lastXXXVar fields are used to optimize fetching of fields from
 217  *              input tuples: they let us do a slot_getsomeattrs() call to ensure
 218  *              that all needed attributes are extracted in one pass.
 219  *
 220  *              targetlist              target list for projection (non-Var expressions only)
 221  *              exprContext             expression context in which to evaluate targetlist
 222  *              slot                    slot to place projection result in
 223  *              itemIsDone              workspace array for ExecProject
 224  *              directMap               true if varOutputCols[] is an identity map
 225  *              numSimpleVars   number of simple Vars found in original tlist
 226  *              varSlotOffsets  array indicating which slot each simple Var is from
 227  *              varNumbers              array containing input attr numbers of simple Vars
 228  *              varOutputCols   array containing output attr numbers of simple Vars
 229  *              lastInnerVar    highest attnum from inner tuple slot (0 if none)
 230  *              lastOuterVar    highest attnum from outer tuple slot (0 if none)
 231  *              lastScanVar             highest attnum from scan tuple slot (0 if none)
 232  * ----------------
 233  */
 234 typedef struct ProjectionInfo
 235 {
 236         NodeTag         type;
 237         List       *pi_targetlist;
 238         ExprContext *pi_exprContext;
 239         TupleTableSlot *pi_slot;
 240         ExprDoneCond *pi_itemIsDone;
 241         bool            pi_directMap;
 242         int                     pi_numSimpleVars;
 243         int                *pi_varSlotOffsets;
 244         int                *pi_varNumbers;
 245         int                *pi_varOutputCols;
 246         int                     pi_lastInnerVar;
 247         int                     pi_lastOuterVar;
 248         int                     pi_lastScanVar;
 249 } ProjectionInfo;
 250
 251 /* ----------------
 252  *        JunkFilter
 253  *
 254  *        This class is used to store information regarding junk attributes.
 255  *        A junk attribute is an attribute in a tuple that is needed only for
 256  *        storing intermediate information in the executor, and does not belong
 257  *        in emitted tuples.  For example, when we do an UPDATE query,
 258  *        the planner adds a "junk" entry to the targetlist so that the tuples
 259  *        returned to ExecutePlan() contain an extra attribute: the ctid of
 260  *        the tuple to be updated.      This is needed to do the update, but we
 261  *        don't want the ctid to be part of the stored new tuple!  So, we
 262  *        apply a "junk filter" to remove the junk attributes and form the
 263  *        real output tuple.  The junkfilter code also provides routines to
 264  *        extract the values of the junk attribute(s) from the input tuple.
 265  *
 266  *        targetList:           the original target list (including junk attributes).
 267  *        cleanTupType:         the tuple descriptor for the "clean" tuple (with
 268  *                                              junk attributes removed).
 269  *        cleanMap:                     A map with the correspondence between the non-junk
 270  *                                              attribute numbers of the "original" tuple and the
 271  *                                              attribute numbers of the "clean" tuple.
 272  *        resultSlot:           tuple slot used to hold cleaned tuple.
 273  *        junkAttNo:            not used by junkfilter code.  Can be used by caller
 274  *                                              to remember the attno of a specific junk attribute
 275  *                                              (execMain.c stores the "ctid" attno here).
 276  * ----------------
 277  */
 278 typedef struct JunkFilter
 279 {
 280         NodeTag         type;
 281         List       *jf_targetList;
 282         TupleDesc       jf_cleanTupType;
 283         AttrNumber *jf_cleanMap;
 284         TupleTableSlot *jf_resultSlot;
 285         AttrNumber      jf_junkAttNo;
 286 } JunkFilter;
 287
 288 /* ----------------
 289  *        ResultRelInfo information
 290  *
 291  *              Whenever we update an existing relation, we have to
 292  *              update indices on the relation, and perhaps also fire triggers.
 293  *              The ResultRelInfo class is used to hold all the information needed
 294  *              about a result relation, including indices.. -cim 10/15/89
 295  *
 296  *              RangeTableIndex                 result relation's range table index
 297  *              RelationDesc                    relation descriptor for result relation
 298  *              NumIndices                              # of indices existing on result relation
 299  *              IndexRelationDescs              array of relation descriptors for indices
 300  *              IndexRelationInfo               array of key/attr info for indices
 301  *              TrigDesc                                triggers to be fired, if any
 302  *              TrigFunctions                   cached lookup info for trigger functions
 303  *              TrigWhenExprs                   array of trigger WHEN expr states
 304  *              TrigInstrument                  optional runtime measurements for triggers
 305  *              ConstraintExprs                 array of constraint-checking expr states
 306  *              junkFilter                              for removing junk attributes from tuples
 307  *              projectReturning                for computing a RETURNING list
 308  * ----------------
 309  */
 310 typedef struct ResultRelInfo
 311 {
 312         NodeTag         type;
 313         Index           ri_RangeTableIndex;
 314         Relation        ri_RelationDesc;
 315         int                     ri_NumIndices;
 316         RelationPtr ri_IndexRelationDescs;
 317         IndexInfo **ri_IndexRelationInfo;
 318         TriggerDesc *ri_TrigDesc;
 319         FmgrInfo   *ri_TrigFunctions;
 320         List      **ri_TrigWhenExprs;
 321         struct Instrumentation *ri_TrigInstrument;
 322         List      **ri_ConstraintExprs;
 323         JunkFilter *ri_junkFilter;
 324         ProjectionInfo *ri_projectReturning;
 325 } ResultRelInfo;
 326
 327 /* ----------------
 328  *        EState information
 329  *
 330  * Master working state for an Executor invocation
 331  * ----------------
 332  */
 333 typedef struct EState
 334 {
 335         NodeTag         type;
 336
 337         /* Basic state for all query types: */
 338         ScanDirection es_direction; /* current scan direction */
 339         Snapshot        es_snapshot;    /* time qual to use */
 340         Snapshot        es_crosscheck_snapshot; /* crosscheck time qual for RI */
 341         List       *es_range_table; /* List of RangeTblEntry */
 342         PlannedStmt *es_plannedstmt;    /* link to top of plan tree */
 343
 344         JunkFilter *es_junkFilter;      /* top-level junk filter, if any */
 345
 346         /* If query can insert/delete tuples, the command ID to mark them with */
 347         CommandId       es_output_cid;
 348
 349         /* Info about target table for insert/update/delete queries: */
 350         ResultRelInfo *es_result_relations; /* array of ResultRelInfos */
 351         int                     es_num_result_relations;                /* length of array */
 352         ResultRelInfo *es_result_relation_info;         /* currently active array elt */
 353
 354         /* Stuff used for firing triggers: */
 355         List       *es_trig_target_relations;           /* trigger-only ResultRelInfos */
 356         TupleTableSlot *es_trig_tuple_slot;             /* for trigger output tuples */
 357         TupleTableSlot *es_trig_oldtup_slot;    /* for trigger old tuples */
 358
 359         /* Parameter info: */
 360         ParamListInfo es_param_list_info;       /* values of external params */
 361         ParamExecData *es_param_exec_vals;      /* values of internal params */
 362
 363         /* Other working state: */
 364         MemoryContext es_query_cxt; /* per-query context in which EState lives */
 365
 366         List       *es_tupleTable;      /* List of TupleTableSlots */
 367
 368         List       *es_rowMarks;        /* List of ExecRowMarks */
 369
 370         uint32          es_processed;   /* # of tuples processed */
 371         Oid                     es_lastoid;             /* last oid processed (by INSERT) */
 372
 373         int                     es_instrument;  /* OR of InstrumentOption flags */
 374         bool            es_select_into; /* true if doing SELECT INTO */
 375         bool            es_into_oids;   /* true to generate OIDs in SELECT INTO */
 376
 377         List       *es_exprcontexts;    /* List of ExprContexts within EState */
 378
 379         List       *es_subplanstates;           /* List of PlanState for SubPlans */
 380
 381         /*
 382          * this ExprContext is for per-output-tuple operations, such as constraint
 383          * checks and index-value computations.  It will be reset for each output
 384          * tuple.  Note that it will be created only if needed.
 385          */
 386         ExprContext *es_per_tuple_exprcontext;
 387
 388         /*
 389          * These fields are for re-evaluating plan quals when an updated tuple is
 390          * substituted in READ COMMITTED mode.  es_epqTuple[] contains tuples
 391          * that scan plan nodes should return instead of whatever they'd normally
 392          * return, or NULL if nothing to return; es_epqTupleSet[] is true if a
 393          * particular array entry is valid; and es_epqScanDone[] is state to
 394          * remember if the tuple has been returned already.  Arrays are of size
 395          * list_length(es_range_table) and are indexed by scan node scanrelid - 1.
 396          */
 397         HeapTuple  *es_epqTuple;                /* array of EPQ substitute tuples */
 398         bool       *es_epqTupleSet;             /* true if EPQ tuple is provided */
 399         bool       *es_epqScanDone;             /* true if EPQ tuple has been fetched */
 400 } EState;
 401
 402
 403 /*
 404  * ExecRowMark -
 405  *         runtime representation of FOR UPDATE/SHARE clauses
 406  *
 407  * When doing UPDATE, DELETE, or SELECT FOR UPDATE/SHARE, we should have an
 408  * ExecRowMark for each non-target relation in the query (except inheritance
 409  * parent RTEs, which can be ignored at runtime).  See PlanRowMark for details
 410  * about most of the fields.
 411  *
 412  * es_rowMarks is a list of these structs.  Each LockRows node has its own
 413  * list, which is the subset of locks that it is supposed to enforce; note
 414  * that the per-node lists point to the same structs that are in the global
 415  * list.
 416  */
 417 typedef struct ExecRowMark
 418 {
 419         Relation        relation;               /* opened and suitably locked relation */
 420         Index           rti;                    /* its range table index */
 421         Index           prti;                   /* parent range table index, if child */
 422         RowMarkType     markType;               /* see enum in nodes/plannodes.h */
 423         bool            noWait;                 /* NOWAIT option */
 424         AttrNumber      ctidAttNo;              /* resno of ctid junk attribute, if any */
 425         AttrNumber      toidAttNo;              /* resno of tableoid junk attribute, if any */
 426         AttrNumber      wholeAttNo;             /* resno of whole-row junk attribute, if any */
 427         ItemPointerData curCtid;        /* ctid of currently locked tuple, if any */
 428 } ExecRowMark;
 429
 430
 431 /* ----------------------------------------------------------------
 432  *                               Tuple Hash Tables
 433  *
 434  * All-in-memory tuple hash tables are used for a number of purposes.
 435  *
 436  * Note: tab_hash_funcs are for the key datatype(s) stored in the table,
 437  * and tab_eq_funcs are non-cross-type equality operators for those types.
 438  * Normally these are the only functions used, but FindTupleHashEntry()
 439  * supports searching a hashtable using cross-data-type hashing.  For that,
 440  * the caller must supply hash functions for the LHS datatype as well as
 441  * the cross-type equality operators to use.  in_hash_funcs and cur_eq_funcs
 442  * are set to point to the caller's function arrays while doing such a search.
 443  * During LookupTupleHashEntry(), they point to tab_hash_funcs and
 444  * tab_eq_funcs respectively.
 445  * ----------------------------------------------------------------
 446  */
 447 typedef struct TupleHashEntryData *TupleHashEntry;
 448 typedef struct TupleHashTableData *TupleHashTable;
 449
 450 typedef struct TupleHashEntryData
 451 {
 452         /* firstTuple must be the first field in this struct! */
 453         MinimalTuple firstTuple;        /* copy of first tuple in this group */
 454         /* there may be additional data beyond the end of this struct */
 455 } TupleHashEntryData;                   /* VARIABLE LENGTH STRUCT */
 456
 457 typedef struct TupleHashTableData
 458 {
 459         HTAB       *hashtab;            /* underlying dynahash table */
 460         int                     numCols;                /* number of columns in lookup key */
 461         AttrNumber *keyColIdx;          /* attr numbers of key columns */
 462         FmgrInfo   *tab_hash_funcs; /* hash functions for table datatype(s) */
 463         FmgrInfo   *tab_eq_funcs;       /* equality functions for table datatype(s) */
 464         MemoryContext tablecxt;         /* memory context containing table */
 465         MemoryContext tempcxt;          /* context for function evaluations */
 466         Size            entrysize;              /* actual size to make each hash entry */
 467         TupleTableSlot *tableslot;      /* slot for referencing table entries */
 468         /* The following fields are set transiently for each table search: */
 469         TupleTableSlot *inputslot;      /* current input tuple's slot */
 470         FmgrInfo   *in_hash_funcs;      /* hash functions for input datatype(s) */
 471         FmgrInfo   *cur_eq_funcs;       /* equality functions for input vs. table */
 472 } TupleHashTableData;
 473
 474 typedef HASH_SEQ_STATUS TupleHashIterator;
 475
 476 /*
 477  * Use InitTupleHashIterator/TermTupleHashIterator for a read/write scan.
 478  * Use ResetTupleHashIterator if the table can be frozen (in this case no
 479  * explicit scan termination is needed).
 480  */
 481 #define InitTupleHashIterator(htable, iter) \
 482         hash_seq_init(iter, (htable)->hashtab)
 483 #define TermTupleHashIterator(iter) \
 484         hash_seq_term(iter)
 485 #define ResetTupleHashIterator(htable, iter) \
 486         do { \
 487                 hash_freeze((htable)->hashtab); \
 488                 hash_seq_init(iter, (htable)->hashtab); \
 489         } while (0)
 490 #define ScanTupleHashTable(iter) \
 491         ((TupleHashEntry) hash_seq_search(iter))
 492
 493
 494 /* ----------------------------------------------------------------
 495  *                               Expression State Trees
 496  *
 497  * Each executable expression tree has a parallel ExprState tree.
 498  *
 499  * Unlike PlanState, there is not an exact one-for-one correspondence between
 500  * ExprState node types and Expr node types.  Many Expr node types have no
 501  * need for node-type-specific run-time state, and so they can use plain
 502  * ExprState or GenericExprState as their associated ExprState node type.
 503  * ----------------------------------------------------------------
 504  */
 505
 506 /* ----------------
 507  *              ExprState node
 508  *
 509  * ExprState is the common superclass for all ExprState-type nodes.
 510  *
 511  * It can also be instantiated directly for leaf Expr nodes that need no
 512  * local run-time state (such as Var, Const, or Param).
 513  *
 514  * To save on dispatch overhead, each ExprState node contains a function
 515  * pointer to the routine to execute to evaluate the node.
 516  * ----------------
 517  */
 518
 519 typedef struct ExprState ExprState;
 520
 521 typedef Datum (*ExprStateEvalFunc) (ExprState *expression,
 522                                                                                                 ExprContext *econtext,
 523                                                                                                 bool *isNull,
 524                                                                                                 ExprDoneCond *isDone);
 525
 526 struct ExprState
 527 {
 528         NodeTag         type;
 529         Expr       *expr;                       /* associated Expr node */
 530         ExprStateEvalFunc evalfunc; /* routine to run to execute node */
 531 };
 532
 533 /* ----------------
 534  *              GenericExprState node
 535  *
 536  * This is used for Expr node types that need no local run-time state,
 537  * but have one child Expr node.
 538  * ----------------
 539  */
 540 typedef struct GenericExprState
 541 {
 542         ExprState       xprstate;
 543         ExprState  *arg;                        /* state of my child node */
 544 } GenericExprState;
 545
 546 /* ----------------
 547  *              AggrefExprState node
 548  * ----------------
 549  */
 550 typedef struct AggrefExprState
 551 {
 552         ExprState       xprstate;
 553         List       *args;                       /* states of argument expressions */
 554         int                     aggno;                  /* ID number for agg within its plan node */
 555 } AggrefExprState;
 556
 557 /* ----------------
 558  *              WindowFuncExprState node
 559  * ----------------
 560  */
 561 typedef struct WindowFuncExprState
 562 {
 563         ExprState       xprstate;
 564         List       *args;                       /* states of argument expressions */
 565         int                     wfuncno;                /* ID number for wfunc within its plan node */
 566 } WindowFuncExprState;
 567
 568 /* ----------------
 569  *              ArrayRefExprState node
 570  *
 571  * Note: array types can be fixed-length (typlen > 0), but only when the
 572  * element type is itself fixed-length.  Otherwise they are varlena structures
 573  * and have typlen = -1.  In any case, an array type is never pass-by-value.
 574  * ----------------
 575  */
 576 typedef struct ArrayRefExprState
 577 {
 578         ExprState       xprstate;
 579         List       *refupperindexpr;    /* states for child nodes */
 580         List       *reflowerindexpr;
 581         ExprState  *refexpr;
 582         ExprState  *refassgnexpr;
 583         int16           refattrlength;  /* typlen of array type */
 584         int16           refelemlength;  /* typlen of the array element type */
 585         bool            refelembyval;   /* is the element type pass-by-value? */
 586         char            refelemalign;   /* typalign of the element type */
 587 } ArrayRefExprState;
 588
 589 /* ----------------
 590  *              FuncExprState node
 591  *
 592  * Although named for FuncExpr, this is also used for OpExpr, DistinctExpr,
 593  * and NullIf nodes; be careful to check what xprstate.expr is actually
 594  * pointing at!
 595  * ----------------
 596  */
 597 typedef struct FuncExprState
 598 {
 599         ExprState       xprstate;
 600         List       *args;                       /* states of argument expressions */
 601
 602         /*
 603          * Function manager's lookup info for the target function.  If func.fn_oid
 604          * is InvalidOid, we haven't initialized it yet (nor any of the following
 605          * fields).
 606          */
 607         FmgrInfo        func;
 608
 609         /*
 610          * For a set-returning function (SRF) that returns a tuplestore, we keep
 611          * the tuplestore here and dole out the result rows one at a time. The
 612          * slot holds the row currently being returned.
 613          */
 614         Tuplestorestate *funcResultStore;
 615         TupleTableSlot *funcResultSlot;
 616
 617         /*
 618          * In some cases we need to compute a tuple descriptor for the function's
 619          * output.      If so, it's stored here.
 620          */
 621         TupleDesc       funcResultDesc;
 622         bool            funcReturnsTuple;               /* valid when funcResultDesc isn't
 623                                                                                  * NULL */
 624
 625         /*
 626          * We need to store argument values across calls when evaluating a SRF
 627          * that uses value-per-call mode.
 628          *
 629          * setArgsValid is true when we are evaluating a set-valued function and
 630          * we are in the middle of a call series; we want to pass the same
 631          * argument values to the function again (and again, until it returns
 632          * ExprEndResult).
 633          */
 634         bool            setArgsValid;
 635
 636         /*
 637          * Flag to remember whether we found a set-valued argument to the
 638          * function. This causes the function result to be a set as well. Valid
 639          * only when setArgsValid is true or funcResultStore isn't NULL.
 640          */
 641         bool            setHasSetArg;   /* some argument returns a set */
 642
 643         /*
 644          * Flag to remember whether we have registered a shutdown callback for
 645          * this FuncExprState.  We do so only if funcResultStore or setArgsValid
 646          * has been set at least once (since all the callback is for is to release
 647          * the tuplestore or clear setArgsValid).
 648          */
 649         bool            shutdown_reg;   /* a shutdown callback is registered */
 650
 651         /*
 652          * Current argument data for a set-valued function; contains valid data
 653          * only if setArgsValid is true.
 654          */
 655         FunctionCallInfoData setArgs;
 656 } FuncExprState;
 657
 658 /* ----------------
 659  *              ScalarArrayOpExprState node
 660  *
 661  * This is a FuncExprState plus some additional data.
 662  * ----------------
 663  */
 664 typedef struct ScalarArrayOpExprState
 665 {
 666         FuncExprState fxprstate;
 667         /* Cached info about array element type */
 668         Oid                     element_type;
 669         int16           typlen;
 670         bool            typbyval;
 671         char            typalign;
 672 } ScalarArrayOpExprState;
 673
 674 /* ----------------
 675  *              BoolExprState node
 676  * ----------------
 677  */
 678 typedef struct BoolExprState
 679 {
 680         ExprState       xprstate;
 681         List       *args;                       /* states of argument expression(s) */
 682 } BoolExprState;
 683
 684 /* ----------------
 685  *              SubPlanState node
 686  * ----------------
 687  */
 688 typedef struct SubPlanState
 689 {
 690         ExprState       xprstate;
 691         struct PlanState *planstate;    /* subselect plan's state tree */
 692         ExprState  *testexpr;           /* state of combining expression */
 693         List       *args;                       /* states of argument expression(s) */
 694         HeapTuple       curTuple;               /* copy of most recent tuple from subplan */
 695         /* these are used when hashing the subselect's output: */
 696         ProjectionInfo *projLeft;       /* for projecting lefthand exprs */
 697         ProjectionInfo *projRight;      /* for projecting subselect output */
 698         TupleHashTable hashtable;       /* hash table for no-nulls subselect rows */
 699         TupleHashTable hashnulls;       /* hash table for rows with null(s) */
 700         bool            havehashrows;   /* TRUE if hashtable is not empty */
 701         bool            havenullrows;   /* TRUE if hashnulls is not empty */
 702         MemoryContext tablecxt;         /* memory context containing tables */
 703         ExprContext *innerecontext; /* working context for comparisons */
 704         AttrNumber *keyColIdx;          /* control data for hash tables */
 705         FmgrInfo   *tab_hash_funcs; /* hash functions for table datatype(s) */
 706         FmgrInfo   *tab_eq_funcs;       /* equality functions for table datatype(s) */
 707         FmgrInfo   *lhs_hash_funcs; /* hash functions for lefthand datatype(s) */
 708         FmgrInfo   *cur_eq_funcs;       /* equality functions for LHS vs. table */
 709 } SubPlanState;
 710
 711 /* ----------------
 712  *              AlternativeSubPlanState node
 713  * ----------------
 714  */
 715 typedef struct AlternativeSubPlanState
 716 {
 717         ExprState       xprstate;
 718         List       *subplans;           /* states of alternative subplans */
 719         int                     active;                 /* list index of the one we're using */
 720 } AlternativeSubPlanState;
 721
 722 /* ----------------
 723  *              FieldSelectState node
 724  * ----------------
 725  */
 726 typedef struct FieldSelectState
 727 {
 728         ExprState       xprstate;
 729         ExprState  *arg;                        /* input expression */
 730         TupleDesc       argdesc;                /* tupdesc for most recent input */
 731 } FieldSelectState;
 732
 733 /* ----------------
 734  *              FieldStoreState node
 735  * ----------------
 736  */
 737 typedef struct FieldStoreState
 738 {
 739         ExprState       xprstate;
 740         ExprState  *arg;                        /* input tuple value */
 741         List       *newvals;            /* new value(s) for field(s) */
 742         TupleDesc       argdesc;                /* tupdesc for most recent input */
 743 } FieldStoreState;
 744
 745 /* ----------------
 746  *              CoerceViaIOState node
 747  * ----------------
 748  */
 749 typedef struct CoerceViaIOState
 750 {
 751         ExprState       xprstate;
 752         ExprState  *arg;                        /* input expression */
 753         FmgrInfo        outfunc;                /* lookup info for source output function */
 754         FmgrInfo        infunc;                 /* lookup info for result input function */
 755         Oid                     intypioparam;   /* argument needed for input function */
 756 } CoerceViaIOState;
 757
 758 /* ----------------
 759  *              ArrayCoerceExprState node
 760  * ----------------
 761  */
 762 typedef struct ArrayCoerceExprState
 763 {
 764         ExprState       xprstate;
 765         ExprState  *arg;                        /* input array value */
 766         Oid                     resultelemtype; /* element type of result array */
 767         FmgrInfo        elemfunc;               /* lookup info for element coercion function */
 768         /* use struct pointer to avoid including array.h here */
 769         struct ArrayMapState *amstate;          /* workspace for array_map */
 770 } ArrayCoerceExprState;
 771
 772 /* ----------------
 773  *              ConvertRowtypeExprState node
 774  * ----------------
 775  */
 776 typedef struct ConvertRowtypeExprState
 777 {
 778         ExprState       xprstate;
 779         ExprState  *arg;                        /* input tuple value */
 780         TupleDesc       indesc;                 /* tupdesc for source rowtype */
 781         TupleDesc       outdesc;                /* tupdesc for result rowtype */
 782         /* use "struct" so we needn't include tupconvert.h here */
 783         struct TupleConversionMap *map;
 784         bool            initialized;
 785 } ConvertRowtypeExprState;
 786
 787 /* ----------------
 788  *              CaseExprState node
 789  * ----------------
 790  */
 791 typedef struct CaseExprState
 792 {
 793         ExprState       xprstate;
 794         ExprState  *arg;                        /* implicit equality comparison argument */
 795         List       *args;                       /* the arguments (list of WHEN clauses) */
 796         ExprState  *defresult;          /* the default result (ELSE clause) */
 797 } CaseExprState;
 798
 799 /* ----------------
 800  *              CaseWhenState node
 801  * ----------------
 802  */
 803 typedef struct CaseWhenState
 804 {
 805         ExprState       xprstate;
 806         ExprState  *expr;                       /* condition expression */
 807         ExprState  *result;                     /* substitution result */
 808 } CaseWhenState;
 809
 810 /* ----------------
 811  *              ArrayExprState node
 812  *
 813  * Note: ARRAY[] expressions always produce varlena arrays, never fixed-length
 814  * arrays.
 815  * ----------------
 816  */
 817 typedef struct ArrayExprState
 818 {
 819         ExprState       xprstate;
 820         List       *elements;           /* states for child nodes */
 821         int16           elemlength;             /* typlen of the array element type */
 822         bool            elembyval;              /* is the element type pass-by-value? */
 823         char            elemalign;              /* typalign of the element type */
 824 } ArrayExprState;
 825
 826 /* ----------------
 827  *              RowExprState node
 828  * ----------------
 829  */
 830 typedef struct RowExprState
 831 {
 832         ExprState       xprstate;
 833         List       *args;                       /* the arguments */
 834         TupleDesc       tupdesc;                /* descriptor for result tuples */
 835 } RowExprState;
 836
 837 /* ----------------
 838  *              RowCompareExprState node
 839  * ----------------
 840  */
 841 typedef struct RowCompareExprState
 842 {
 843         ExprState       xprstate;
 844         List       *largs;                      /* the left-hand input arguments */
 845         List       *rargs;                      /* the right-hand input arguments */
 846         FmgrInfo   *funcs;                      /* array of comparison function info */
 847 } RowCompareExprState;
 848
 849 /* ----------------
 850  *              CoalesceExprState node
 851  * ----------------
 852  */
 853 typedef struct CoalesceExprState
 854 {
 855         ExprState       xprstate;
 856         List       *args;                       /* the arguments */
 857 } CoalesceExprState;
 858
 859 /* ----------------
 860  *              MinMaxExprState node
 861  * ----------------
 862  */
 863 typedef struct MinMaxExprState
 864 {
 865         ExprState       xprstate;
 866         List       *args;                       /* the arguments */
 867         FmgrInfo        cfunc;                  /* lookup info for comparison func */
 868 } MinMaxExprState;
 869
 870 /* ----------------
 871  *              XmlExprState node
 872  * ----------------
 873  */
 874 typedef struct XmlExprState
 875 {
 876         ExprState       xprstate;
 877         List       *named_args;         /* ExprStates for named arguments */
 878         List       *args;                       /* ExprStates for other arguments */
 879 } XmlExprState;
 880
 881 /* ----------------
 882  *              NullTestState node
 883  * ----------------
 884  */
 885 typedef struct NullTestState
 886 {
 887         ExprState       xprstate;
 888         ExprState  *arg;                        /* input expression */
 889         /* used only if input is of composite type: */
 890         TupleDesc       argdesc;                /* tupdesc for most recent input */
 891 } NullTestState;
 892
 893 /* ----------------
 894  *              CoerceToDomainState node
 895  * ----------------
 896  */
 897 typedef struct CoerceToDomainState
 898 {
 899         ExprState       xprstate;
 900         ExprState  *arg;                        /* input expression */
 901         /* Cached list of constraints that need to be checked */
 902         List       *constraints;        /* list of DomainConstraintState nodes */
 903 } CoerceToDomainState;
 904
 905 /*
 906  * DomainConstraintState - one item to check during CoerceToDomain
 907  *
 908  * Note: this is just a Node, and not an ExprState, because it has no
 909  * corresponding Expr to link to.  Nonetheless it is part of an ExprState
 910  * tree, so we give it a name following the xxxState convention.
 911  */
 912 typedef enum DomainConstraintType
 913 {
 914         DOM_CONSTRAINT_NOTNULL,
 915         DOM_CONSTRAINT_CHECK
 916 } DomainConstraintType;
 917
 918 typedef struct DomainConstraintState
 919 {
 920         NodeTag         type;
 921         DomainConstraintType constrainttype;            /* constraint type */
 922         char       *name;                       /* name of constraint (for error msgs) */
 923         ExprState  *check_expr;         /* for CHECK, a boolean expression */
 924 } DomainConstraintState;
 925
 926
 927 /* ----------------------------------------------------------------
 928  *                               Executor State Trees
 929  *
 930  * An executing query has a PlanState tree paralleling the Plan tree
 931  * that describes the plan.
 932  * ----------------------------------------------------------------
 933  */
 934
 935 /* ----------------
 936  *              PlanState node
 937  *
 938  * We never actually instantiate any PlanState nodes; this is just the common
 939  * abstract superclass for all PlanState-type nodes.
 940  * ----------------
 941  */
 942 typedef struct PlanState
 943 {
 944         NodeTag         type;
 945
 946         Plan       *plan;                       /* associated Plan node */
 947
 948         EState     *state;                      /* at execution time, states of individual
 949                                                                  * nodes point to one EState for the whole
 950                                                                  * top-level plan */
 951
 952         struct Instrumentation *instrument; /* Optional runtime stats for this
 953                                                                                  * plan node */
 954
 955         /*
 956          * Common structural data for all Plan types.  These links to subsidiary
 957          * state trees parallel links in the associated plan tree (except for the
 958          * subPlan list, which does not exist in the plan tree).
 959          */
 960         List       *targetlist;         /* target list to be computed at this node */
 961         List       *qual;                       /* implicitly-ANDed qual conditions */
 962         struct PlanState *lefttree; /* input plan tree(s) */
 963         struct PlanState *righttree;
 964         List       *initPlan;           /* Init SubPlanState nodes (un-correlated expr
 965                                                                  * subselects) */
 966         List       *subPlan;            /* SubPlanState nodes in my expressions */
 967
 968         /*
 969          * State for management of parameter-change-driven rescanning
 970          */
 971         Bitmapset  *chgParam;           /* set of IDs of changed Params */
 972
 973         /*
 974          * Other run-time state needed by most if not all node types.
 975          */
 976         TupleTableSlot *ps_ResultTupleSlot; /* slot for my result tuples */
 977         ExprContext *ps_ExprContext;    /* node's expression-evaluation context */
 978         ProjectionInfo *ps_ProjInfo;    /* info for doing tuple projection */
 979         bool            ps_TupFromTlist;/* state flag for processing set-valued
 980                                                                  * functions in targetlist */
 981 } PlanState;
 982
 983 /* ----------------
 984  *      these are are defined to avoid confusion problems with "left"
 985  *      and "right" and "inner" and "outer".  The convention is that
 986  *      the "left" plan is the "outer" plan and the "right" plan is
 987  *      the inner plan, but these make the code more readable.
 988  * ----------------
 989  */
 990 #define innerPlanState(node)            (((PlanState *)(node))->righttree)
 991 #define outerPlanState(node)            (((PlanState *)(node))->lefttree)
 992
 993 /*
 994  * EPQState is state for executing an EvalPlanQual recheck on a candidate
 995  * tuple in ModifyTable or LockRows.  The estate and planstate fields are
 996  * NULL if inactive.
 997  */
 998 typedef struct EPQState
 999 {
1000         EState     *estate;                     /* subsidiary EState */
1001         PlanState  *planstate;          /* plan state tree ready to be executed */
1002         TupleTableSlot *origslot;       /* original output tuple to be rechecked */
1003         Plan       *plan;                       /* plan tree to be executed */
1004         List       *rowMarks;           /* ExecRowMarks (non-locking only) */
1005         int                     epqParam;               /* ID of Param to force scan node re-eval */
1006 } EPQState;
1007
1008
1009 /* ----------------
1010  *       ResultState information
1011  * ----------------
1012  */
1013 typedef struct ResultState
1014 {
1015         PlanState       ps;                             /* its first field is NodeTag */
1016         ExprState  *resconstantqual;
1017         bool            rs_done;                /* are we done? */
1018         bool            rs_checkqual;   /* do we need to check the qual? */
1019 } ResultState;
1020
1021 /* ----------------
1022  *       ModifyTableState information
1023  * ----------------
1024  */
1025 typedef struct ModifyTableState
1026 {
1027         PlanState               ps;                             /* its first field is NodeTag */
1028         CmdType                 operation;
1029         PlanState         **mt_plans;           /* subplans (one per target rel) */
1030         int                             mt_nplans;              /* number of plans in the array */
1031         int                             mt_whichplan;   /* which one is being executed (0..n-1) */
1032         EPQState                mt_epqstate;    /* for evaluating EvalPlanQual rechecks */
1033         bool                    fireBSTriggers; /* do we need to fire stmt triggers? */
1034 } ModifyTableState;
1035
1036 /* ----------------
1037  *       AppendState information
1038  *
1039  *              nplans                  how many plans are in the array
1040  *              whichplan               which plan is being executed (0 .. n-1)
1041  * ----------------
1042  */
1043 typedef struct AppendState
1044 {
1045         PlanState       ps;                             /* its first field is NodeTag */
1046         PlanState **appendplans;        /* array of PlanStates for my inputs */
1047         int                     as_nplans;
1048         int                     as_whichplan;
1049 } AppendState;
1050
1051 /* ----------------
1052  *       RecursiveUnionState information
1053  *
1054  *              RecursiveUnionState is used for performing a recursive union.
1055  *
1056  *              recursing                       T when we're done scanning the non-recursive term
1057  *              intermediate_empty      T if intermediate_table is currently empty
1058  *              working_table           working table (to be scanned by recursive term)
1059  *              intermediate_table      current recursive output (next generation of WT)
1060  * ----------------
1061  */
1062 typedef struct RecursiveUnionState
1063 {
1064         PlanState       ps;                             /* its first field is NodeTag */
1065         bool            recursing;
1066         bool            intermediate_empty;
1067         Tuplestorestate *working_table;
1068         Tuplestorestate *intermediate_table;
1069         /* Remaining fields are unused in UNION ALL case */
1070         FmgrInfo   *eqfunctions;        /* per-grouping-field equality fns */
1071         FmgrInfo   *hashfunctions;      /* per-grouping-field hash fns */
1072         MemoryContext tempContext;      /* short-term context for comparisons */
1073         TupleHashTable hashtable;       /* hash table for tuples already seen */
1074         MemoryContext tableContext; /* memory context containing hash table */
1075 } RecursiveUnionState;
1076
1077 /* ----------------
1078  *       BitmapAndState information
1079  * ----------------
1080  */
1081 typedef struct BitmapAndState
1082 {
1083         PlanState       ps;                             /* its first field is NodeTag */
1084         PlanState **bitmapplans;        /* array of PlanStates for my inputs */
1085         int                     nplans;                 /* number of input plans */
1086 } BitmapAndState;
1087
1088 /* ----------------
1089  *       BitmapOrState information
1090  * ----------------
1091  */
1092 typedef struct BitmapOrState
1093 {
1094         PlanState       ps;                             /* its first field is NodeTag */
1095         PlanState **bitmapplans;        /* array of PlanStates for my inputs */
1096         int                     nplans;                 /* number of input plans */
1097 } BitmapOrState;
1098
1099 /* ----------------------------------------------------------------
1100  *                               Scan State Information
1101  * ----------------------------------------------------------------
1102  */
1103
1104 /* ----------------
1105  *       ScanState information
1106  *
1107  *              ScanState extends PlanState for node types that represent
1108  *              scans of an underlying relation.  It can also be used for nodes
1109  *              that scan the output of an underlying plan node --- in that case,
1110  *              only ScanTupleSlot is actually useful, and it refers to the tuple
1111  *              retrieved from the subplan.
1112  *
1113  *              currentRelation    relation being scanned (NULL if none)
1114  *              currentScanDesc    current scan descriptor for scan (NULL if none)
1115  *              ScanTupleSlot      pointer to slot in tuple table holding scan tuple
1116  * ----------------
1117  */
1118 typedef struct ScanState
1119 {
1120         PlanState       ps;                             /* its first field is NodeTag */
1121         Relation        ss_currentRelation;
1122         HeapScanDesc ss_currentScanDesc;
1123         TupleTableSlot *ss_ScanTupleSlot;
1124 } ScanState;
1125
1126 /*
1127  * SeqScan uses a bare ScanState as its state node, since it needs
1128  * no additional fields.
1129  */
1130 typedef ScanState SeqScanState;
1131
1132 /*
1133  * These structs store information about index quals that don't have simple
1134  * constant right-hand sides.  See comments for ExecIndexBuildScanKeys()
1135  * for discussion.
1136  */
1137 typedef struct
1138 {
1139         ScanKey         scan_key;               /* scankey to put value into */
1140         ExprState  *key_expr;           /* expr to evaluate to get value */
1141         bool            key_toastable;  /* is expr's result a toastable datatype? */
1142 } IndexRuntimeKeyInfo;
1143
1144 typedef struct
1145 {
1146         ScanKey         scan_key;               /* scankey to put value into */
1147         ExprState  *array_expr;         /* expr to evaluate to get array value */
1148         int                     next_elem;              /* next array element to use */
1149         int                     num_elems;              /* number of elems in current array value */
1150         Datum      *elem_values;        /* array of num_elems Datums */
1151         bool       *elem_nulls;         /* array of num_elems is-null flags */
1152 } IndexArrayKeyInfo;
1153
1154 /* ----------------
1155  *       IndexScanState information
1156  *
1157  *              indexqualorig      execution state for indexqualorig expressions
1158  *              ScanKeys                   Skey structures to scan index rel
1159  *              NumScanKeys                number of Skey structs
1160  *              RuntimeKeys                info about Skeys that must be evaluated at runtime
1161  *              NumRuntimeKeys     number of RuntimeKeys structs
1162  *              RuntimeKeysReady   true if runtime Skeys have been computed
1163  *              RuntimeContext     expr context for evaling runtime Skeys
1164  *              RelationDesc       index relation descriptor
1165  *              ScanDesc                   index scan descriptor
1166  * ----------------
1167  */
1168 typedef struct IndexScanState
1169 {
1170         ScanState       ss;                             /* its first field is NodeTag */
1171         List       *indexqualorig;
1172         ScanKey         iss_ScanKeys;
1173         int                     iss_NumScanKeys;
1174         IndexRuntimeKeyInfo *iss_RuntimeKeys;
1175         int                     iss_NumRuntimeKeys;
1176         bool            iss_RuntimeKeysReady;
1177         ExprContext *iss_RuntimeContext;
1178         Relation        iss_RelationDesc;
1179         IndexScanDesc iss_ScanDesc;
1180 } IndexScanState;
1181
1182 /* ----------------
1183  *       BitmapIndexScanState information
1184  *
1185  *              result                     bitmap to return output into, or NULL
1186  *              ScanKeys                   Skey structures to scan index rel
1187  *              NumScanKeys                number of Skey structs
1188  *              RuntimeKeys                info about Skeys that must be evaluated at runtime
1189  *              NumRuntimeKeys     number of RuntimeKeys structs
1190  *              ArrayKeys                  info about Skeys that come from ScalarArrayOpExprs
1191  *              NumArrayKeys       number of ArrayKeys structs
1192  *              RuntimeKeysReady   true if runtime Skeys have been computed
1193  *              RuntimeContext     expr context for evaling runtime Skeys
1194  *              RelationDesc       index relation descriptor
1195  *              ScanDesc                   index scan descriptor
1196  * ----------------
1197  */
1198 typedef struct BitmapIndexScanState
1199 {
1200         ScanState       ss;                             /* its first field is NodeTag */
1201         TIDBitmap  *biss_result;
1202         ScanKey         biss_ScanKeys;
1203         int                     biss_NumScanKeys;
1204         IndexRuntimeKeyInfo *biss_RuntimeKeys;
1205         int                     biss_NumRuntimeKeys;
1206         IndexArrayKeyInfo *biss_ArrayKeys;
1207         int                     biss_NumArrayKeys;
1208         bool            biss_RuntimeKeysReady;
1209         ExprContext *biss_RuntimeContext;
1210         Relation        biss_RelationDesc;
1211         IndexScanDesc biss_ScanDesc;
1212 } BitmapIndexScanState;
1213
1214 /* ----------------
1215  *       BitmapHeapScanState information
1216  *
1217  *              bitmapqualorig     execution state for bitmapqualorig expressions
1218  *              tbm                                bitmap obtained from child index scan(s)
1219  *              tbmiterator                iterator for scanning current pages
1220  *              tbmres                     current-page data
1221  *              prefetch_iterator  iterator for prefetching ahead of current page
1222  *              prefetch_pages     # pages prefetch iterator is ahead of current
1223  *              prefetch_target    target prefetch distance
1224  * ----------------
1225  */
1226 typedef struct BitmapHeapScanState
1227 {
1228         ScanState       ss;                             /* its first field is NodeTag */
1229         List       *bitmapqualorig;
1230         TIDBitmap  *tbm;
1231         TBMIterator *tbmiterator;
1232         TBMIterateResult *tbmres;
1233         TBMIterator *prefetch_iterator;
1234         int                     prefetch_pages;
1235         int                     prefetch_target;
1236 } BitmapHeapScanState;
1237
1238 /* ----------------
1239  *       TidScanState information
1240  *
1241  *              isCurrentOf    scan has a CurrentOfExpr qual
1242  *              NumTids            number of tids in this scan
1243  *              TidPtr             index of currently fetched tid
1244  *              TidList            evaluated item pointers (array of size NumTids)
1245  * ----------------
1246  */
1247 typedef struct TidScanState
1248 {
1249         ScanState       ss;                             /* its first field is NodeTag */
1250         List       *tss_tidquals;       /* list of ExprState nodes */
1251         bool            tss_isCurrentOf;
1252         int                     tss_NumTids;
1253         int                     tss_TidPtr;
1254         int                     tss_MarkTidPtr;
1255         ItemPointerData *tss_TidList;
1256         HeapTupleData tss_htup;
1257 } TidScanState;
1258
1259 /* ----------------
1260  *       SubqueryScanState information
1261  *
1262  *              SubqueryScanState is used for scanning a sub-query in the range table.
1263  *              ScanTupleSlot references the current output tuple of the sub-query.
1264  * ----------------
1265  */
1266 typedef struct SubqueryScanState
1267 {
1268         ScanState       ss;                             /* its first field is NodeTag */
1269         PlanState  *subplan;
1270 } SubqueryScanState;
1271
1272 /* ----------------
1273  *       FunctionScanState information
1274  *
1275  *              Function nodes are used to scan the results of a
1276  *              function appearing in FROM (typically a function returning set).
1277  *
1278  *              eflags                          node's capability flags
1279  *              tupdesc                         expected return tuple description
1280  *              tuplestorestate         private state of tuplestore.c
1281  *              funcexpr                        state for function expression being evaluated
1282  * ----------------
1283  */
1284 typedef struct FunctionScanState
1285 {
1286         ScanState       ss;                             /* its first field is NodeTag */
1287         int                     eflags;
1288         TupleDesc       tupdesc;
1289         Tuplestorestate *tuplestorestate;
1290         ExprState  *funcexpr;
1291 } FunctionScanState;
1292
1293 /* ----------------
1294  *       ValuesScanState information
1295  *
1296  *              ValuesScan nodes are used to scan the results of a VALUES list
1297  *
1298  *              rowcontext                      per-expression-list context
1299  *              exprlists                       array of expression lists being evaluated
1300  *              array_len                       size of array
1301  *              curr_idx                        current array index (0-based)
1302  *              marked_idx                      marked position (for mark/restore)
1303  *
1304  *      Note: ss.ps.ps_ExprContext is used to evaluate any qual or projection
1305  *      expressions attached to the node.  We create a second ExprContext,
1306  *      rowcontext, in which to build the executor expression state for each
1307  *      Values sublist.  Resetting this context lets us get rid of expression
1308  *      state for each row, avoiding major memory leakage over a long values list.
1309  * ----------------
1310  */
1311 typedef struct ValuesScanState
1312 {
1313         ScanState       ss;                             /* its first field is NodeTag */
1314         ExprContext *rowcontext;
1315         List      **exprlists;
1316         int                     array_len;
1317         int                     curr_idx;
1318         int                     marked_idx;
1319 } ValuesScanState;
1320
1321 /* ----------------
1322  *       CteScanState information
1323  *
1324  *              CteScan nodes are used to scan a CommonTableExpr query.
1325  *
1326  * Multiple CteScan nodes can read out from the same CTE query.  We use
1327  * a tuplestore to hold rows that have been read from the CTE query but
1328  * not yet consumed by all readers.
1329  * ----------------
1330  */
1331 typedef struct CteScanState
1332 {
1333         ScanState       ss;                             /* its first field is NodeTag */
1334         int                     eflags;                 /* capability flags to pass to tuplestore */
1335         int                     readptr;                /* index of my tuplestore read pointer */
1336         PlanState  *cteplanstate;       /* PlanState for the CTE query itself */
1337         /* Link to the "leader" CteScanState (possibly this same node) */
1338         struct CteScanState *leader;
1339         /* The remaining fields are only valid in the "leader" CteScanState */
1340         Tuplestorestate *cte_table; /* rows already read from the CTE query */
1341         bool            eof_cte;                /* reached end of CTE query? */
1342 } CteScanState;
1343
1344 /* ----------------
1345  *       WorkTableScanState information
1346  *
1347  *              WorkTableScan nodes are used to scan the work table created by
1348  *              a RecursiveUnion node.  We locate the RecursiveUnion node
1349  *              during executor startup.
1350  * ----------------
1351  */
1352 typedef struct WorkTableScanState
1353 {
1354         ScanState       ss;                             /* its first field is NodeTag */
1355         RecursiveUnionState *rustate;
1356 } WorkTableScanState;
1357
1358 /* ----------------------------------------------------------------
1359  *                               Join State Information
1360  * ----------------------------------------------------------------
1361  */
1362
1363 /* ----------------
1364  *       JoinState information
1365  *
1366  *              Superclass for state nodes of join plans.
1367  * ----------------
1368  */
1369 typedef struct JoinState
1370 {
1371         PlanState       ps;
1372         JoinType        jointype;
1373         List       *joinqual;           /* JOIN quals (in addition to ps.qual) */
1374 } JoinState;
1375
1376 /* ----------------
1377  *       NestLoopState information
1378  *
1379  *              NeedNewOuter       true if need new outer tuple on next call
1380  *              MatchedOuter       true if found a join match for current outer tuple
1381  *              NullInnerTupleSlot prepared null tuple for left outer joins
1382  * ----------------
1383  */
1384 typedef struct NestLoopState
1385 {
1386         JoinState       js;                             /* its first field is NodeTag */
1387         bool            nl_NeedNewOuter;
1388         bool            nl_MatchedOuter;
1389         TupleTableSlot *nl_NullInnerTupleSlot;
1390 } NestLoopState;
1391
1392 /* ----------------
1393  *       MergeJoinState information
1394  *
1395  *              NumClauses                 number of mergejoinable join clauses
1396  *              Clauses                    info for each mergejoinable clause
1397  *              JoinState                  current "state" of join.  see execdefs.h
1398  *              ExtraMarks                 true to issue extra Mark operations on inner scan
1399  *              FillOuter                  true if should emit unjoined outer tuples anyway
1400  *              FillInner                  true if should emit unjoined inner tuples anyway
1401  *              MatchedOuter       true if found a join match for current outer tuple
1402  *              MatchedInner       true if found a join match for current inner tuple
1403  *              OuterTupleSlot     slot in tuple table for cur outer tuple
1404  *              InnerTupleSlot     slot in tuple table for cur inner tuple
1405  *              MarkedTupleSlot    slot in tuple table for marked tuple
1406  *              NullOuterTupleSlot prepared null tuple for right outer joins
1407  *              NullInnerTupleSlot prepared null tuple for left outer joins
1408  *              OuterEContext      workspace for computing outer tuple's join values
1409  *              InnerEContext      workspace for computing inner tuple's join values
1410  * ----------------
1411  */
1412 /* private in nodeMergejoin.c: */
1413 typedef struct MergeJoinClauseData *MergeJoinClause;
1414
1415 typedef struct MergeJoinState
1416 {
1417         JoinState       js;                             /* its first field is NodeTag */
1418         int                     mj_NumClauses;
1419         MergeJoinClause mj_Clauses; /* array of length mj_NumClauses */
1420         int                     mj_JoinState;
1421         bool            mj_ExtraMarks;
1422         bool            mj_FillOuter;
1423         bool            mj_FillInner;
1424         bool            mj_MatchedOuter;
1425         bool            mj_MatchedInner;
1426         TupleTableSlot *mj_OuterTupleSlot;
1427         TupleTableSlot *mj_InnerTupleSlot;
1428         TupleTableSlot *mj_MarkedTupleSlot;
1429         TupleTableSlot *mj_NullOuterTupleSlot;
1430         TupleTableSlot *mj_NullInnerTupleSlot;
1431         ExprContext *mj_OuterEContext;
1432         ExprContext *mj_InnerEContext;
1433 } MergeJoinState;
1434
1435 /* ----------------
1436  *       HashJoinState information
1437  *
1438  *              hj_HashTable                    hash table for the hashjoin
1439  *                                                              (NULL if table not built yet)
1440  *              hj_CurHashValue                 hash value for current outer tuple
1441  *              hj_CurBucketNo                  regular bucket# for current outer tuple
1442  *              hj_CurSkewBucketNo              skew bucket# for current outer tuple
1443  *              hj_CurTuple                             last inner tuple matched to current outer
1444  *                                                              tuple, or NULL if starting search
1445  *                                                              (hj_CurXXX variables are undefined if
1446  *                                                              OuterTupleSlot is empty!)
1447  *              hj_OuterHashKeys                the outer hash keys in the hashjoin condition
1448  *              hj_InnerHashKeys                the inner hash keys in the hashjoin condition
1449  *              hj_HashOperators                the join operators in the hashjoin condition
1450  *              hj_OuterTupleSlot               tuple slot for outer tuples
1451  *              hj_HashTupleSlot                tuple slot for hashed tuples
1452  *              hj_NullInnerTupleSlot   prepared null tuple for left outer joins
1453  *              hj_FirstOuterTupleSlot  first tuple retrieved from outer plan
1454  *              hj_NeedNewOuter                 true if need new outer tuple on next call
1455  *              hj_MatchedOuter                 true if found a join match for current outer
1456  *              hj_OuterNotEmpty                true if outer relation known not empty
1457  * ----------------
1458  */
1459
1460 /* these structs are defined in executor/hashjoin.h: */
1461 typedef struct HashJoinTupleData *HashJoinTuple;
1462 typedef struct HashJoinTableData *HashJoinTable;
1463
1464 typedef struct HashJoinState
1465 {
1466         JoinState       js;                             /* its first field is NodeTag */
1467         List       *hashclauses;        /* list of ExprState nodes */
1468         HashJoinTable hj_HashTable;
1469         uint32          hj_CurHashValue;
1470         int                     hj_CurBucketNo;
1471         int                     hj_CurSkewBucketNo;
1472         HashJoinTuple hj_CurTuple;
1473         List       *hj_OuterHashKeys;           /* list of ExprState nodes */
1474         List       *hj_InnerHashKeys;           /* list of ExprState nodes */
1475         List       *hj_HashOperators;           /* list of operator OIDs */
1476         TupleTableSlot *hj_OuterTupleSlot;
1477         TupleTableSlot *hj_HashTupleSlot;
1478         TupleTableSlot *hj_NullInnerTupleSlot;
1479         TupleTableSlot *hj_FirstOuterTupleSlot;
1480         bool            hj_NeedNewOuter;
1481         bool            hj_MatchedOuter;
1482         bool            hj_OuterNotEmpty;
1483 } HashJoinState;
1484
1485
1486 /* ----------------------------------------------------------------
1487  *                               Materialization State Information
1488  * ----------------------------------------------------------------
1489  */
1490
1491 /* ----------------
1492  *       MaterialState information
1493  *
1494  *              materialize nodes are used to materialize the results
1495  *              of a subplan into a temporary file.
1496  *
1497  *              ss.ss_ScanTupleSlot refers to output of underlying plan.
1498  * ----------------
1499  */
1500 typedef struct MaterialState
1501 {
1502         ScanState       ss;                             /* its first field is NodeTag */
1503         int                     eflags;                 /* capability flags to pass to tuplestore */
1504         bool            eof_underlying; /* reached end of underlying plan? */
1505         Tuplestorestate *tuplestorestate;
1506 } MaterialState;
1507
1508 /* ----------------
1509  *       SortState information
1510  * ----------------
1511  */
1512 typedef struct SortState
1513 {
1514         ScanState       ss;                             /* its first field is NodeTag */
1515         bool            randomAccess;   /* need random access to sort output? */
1516         bool            bounded;                /* is the result set bounded? */
1517         int64           bound;                  /* if bounded, how many tuples are needed */
1518         bool            sort_Done;              /* sort completed yet? */
1519         bool            bounded_Done;   /* value of bounded we did the sort with */
1520         int64           bound_Done;             /* value of bound we did the sort with */
1521         void       *tuplesortstate; /* private state of tuplesort.c */
1522 } SortState;
1523
1524 /* ---------------------
1525  *      GroupState information
1526  * -------------------------
1527  */
1528 typedef struct GroupState
1529 {
1530         ScanState       ss;                             /* its first field is NodeTag */
1531         FmgrInfo   *eqfunctions;        /* per-field lookup data for equality fns */
1532         bool            grp_done;               /* indicates completion of Group scan */
1533 } GroupState;
1534
1535 /* ---------------------
1536  *      AggState information
1537  *
1538  *      ss.ss_ScanTupleSlot refers to output of underlying plan.
1539  *
1540  *      Note: ss.ps.ps_ExprContext contains ecxt_aggvalues and
1541  *      ecxt_aggnulls arrays, which hold the computed agg values for the current
1542  *      input group during evaluation of an Agg node's output tuple(s).  We
1543  *      create a second ExprContext, tmpcontext, in which to evaluate input
1544  *      expressions and run the aggregate transition functions.
1545  * -------------------------
1546  */
1547 /* these structs are private in nodeAgg.c: */
1548 typedef struct AggStatePerAggData *AggStatePerAgg;
1549 typedef struct AggStatePerGroupData *AggStatePerGroup;
1550
1551 typedef struct AggState
1552 {
1553         ScanState       ss;                             /* its first field is NodeTag */
1554         List       *aggs;                       /* all Aggref nodes in targetlist & quals */
1555         int                     numaggs;                /* length of list (could be zero!) */
1556         FmgrInfo   *eqfunctions;        /* per-grouping-field equality fns */
1557         FmgrInfo   *hashfunctions;      /* per-grouping-field hash fns */
1558         AggStatePerAgg peragg;          /* per-Aggref information */
1559         MemoryContext aggcontext;       /* memory context for long-lived data */
1560         ExprContext *tmpcontext;        /* econtext for input expressions */
1561         bool            agg_done;               /* indicates completion of Agg scan */
1562         /* these fields are used in AGG_PLAIN and AGG_SORTED modes: */
1563         AggStatePerGroup pergroup;      /* per-Aggref-per-group working state */
1564         HeapTuple       grp_firstTuple; /* copy of first tuple of current group */
1565         /* these fields are used in AGG_HASHED mode: */
1566         TupleHashTable hashtable;       /* hash table with one entry per group */
1567         TupleTableSlot *hashslot;       /* slot for loading hash table */
1568         List       *hash_needed;        /* list of columns needed in hash table */
1569         bool            table_filled;   /* hash table filled yet? */
1570         TupleHashIterator hashiter; /* for iterating through hash table */
1571 } AggState;
1572
1573 /* ----------------
1574  *      WindowAggState information
1575  * ----------------
1576  */
1577 /* these structs are private in nodeWindowAgg.c: */
1578 typedef struct WindowStatePerFuncData *WindowStatePerFunc;
1579 typedef struct WindowStatePerAggData *WindowStatePerAgg;
1580
1581 typedef struct WindowAggState
1582 {
1583         ScanState       ss;                             /* its first field is NodeTag */
1584
1585         /* these fields are filled in by ExecInitExpr: */
1586         List       *funcs;                      /* all WindowFunc nodes in targetlist */
1587         int                     numfuncs;               /* total number of window functions */
1588         int                     numaggs;                /* number that are plain aggregates */
1589
1590         WindowStatePerFunc perfunc; /* per-window-function information */
1591         WindowStatePerAgg peragg;       /* per-plain-aggregate information */
1592         FmgrInfo   *partEqfunctions;    /* equality funcs for partition columns */
1593         FmgrInfo   *ordEqfunctions; /* equality funcs for ordering columns */
1594         Tuplestorestate *buffer;        /* stores rows of current partition */
1595         int                     current_ptr;    /* read pointer # for current */
1596         int                     agg_ptr;                /* read pointer # for aggregates */
1597         int64           spooled_rows;   /* total # of rows in buffer */
1598         int64           currentpos;             /* position of current row in partition */
1599         int64           frametailpos;   /* current frame tail position */
1600         int64           aggregatedupto; /* rows before this one are aggregated */
1601
1602         MemoryContext wincontext;       /* context for partition-lifespan data */
1603         ExprContext *tmpcontext;        /* short-term evaluation context */
1604
1605         bool            all_done;               /* true if the scan is finished */
1606         bool            partition_spooled;              /* true if all tuples in current
1607                                                                                  * partition have been spooled into
1608                                                                                  * tuplestore */
1609         bool            more_partitions;/* true if there's more partitions after this
1610                                                                  * one */
1611         bool            frametail_valid;/* true if frametailpos is known up to date
1612                                                                  * for current row */
1613
1614         TupleTableSlot *first_part_slot;        /* first tuple of current or next
1615                                                                                  * partition */
1616
1617         /* temporary slots for tuples fetched back from tuplestore */
1618         TupleTableSlot *agg_row_slot;
1619         TupleTableSlot *temp_slot_1;
1620         TupleTableSlot *temp_slot_2;
1621 } WindowAggState;
1622
1623 /* ----------------
1624  *       UniqueState information
1625  *
1626  *              Unique nodes are used "on top of" sort nodes to discard
1627  *              duplicate tuples returned from the sort phase.  Basically
1628  *              all it does is compare the current tuple from the subplan
1629  *              with the previously fetched tuple (stored in its result slot).
1630  *              If the two are identical in all interesting fields, then
1631  *              we just fetch another tuple from the sort and try again.
1632  * ----------------
1633  */
1634 typedef struct UniqueState
1635 {
1636         PlanState       ps;                             /* its first field is NodeTag */
1637         FmgrInfo   *eqfunctions;        /* per-field lookup data for equality fns */
1638         MemoryContext tempContext;      /* short-term context for comparisons */
1639 } UniqueState;
1640
1641 /* ----------------
1642  *       HashState information
1643  * ----------------
1644  */
1645 typedef struct HashState
1646 {
1647         PlanState       ps;                             /* its first field is NodeTag */
1648         HashJoinTable hashtable;        /* hash table for the hashjoin */
1649         List       *hashkeys;           /* list of ExprState nodes */
1650         /* hashkeys is same as parent's hj_InnerHashKeys */
1651 } HashState;
1652
1653 /* ----------------
1654  *       SetOpState information
1655  *
1656  *              Even in "sorted" mode, SetOp nodes are more complex than a simple
1657  *              Unique, since we have to count how many duplicates to return.  But
1658  *              we also support hashing, so this is really more like a cut-down
1659  *              form of Agg.
1660  * ----------------
1661  */
1662 /* this struct is private in nodeSetOp.c: */
1663 typedef struct SetOpStatePerGroupData *SetOpStatePerGroup;
1664
1665 typedef struct SetOpState
1666 {
1667         PlanState       ps;                             /* its first field is NodeTag */
1668         FmgrInfo   *eqfunctions;        /* per-grouping-field equality fns */
1669         FmgrInfo   *hashfunctions;      /* per-grouping-field hash fns */
1670         bool            setop_done;             /* indicates completion of output scan */
1671         long            numOutput;              /* number of dups left to output */
1672         MemoryContext tempContext;      /* short-term context for comparisons */
1673         /* these fields are used in SETOP_SORTED mode: */
1674         SetOpStatePerGroup pergroup;    /* per-group working state */
1675         HeapTuple       grp_firstTuple; /* copy of first tuple of current group */
1676         /* these fields are used in SETOP_HASHED mode: */
1677         TupleHashTable hashtable;       /* hash table with one entry per group */
1678         MemoryContext tableContext; /* memory context containing hash table */
1679         bool            table_filled;   /* hash table filled yet? */
1680         TupleHashIterator hashiter; /* for iterating through hash table */
1681 } SetOpState;
1682
1683 /* ----------------
1684  *       LockRowsState information
1685  *
1686  *              LockRows nodes are used to enforce FOR UPDATE/FOR SHARE locking.
1687  * ----------------
1688  */
1689 typedef struct LockRowsState
1690 {
1691         PlanState       ps;                             /* its first field is NodeTag */
1692         List       *lr_rowMarks;        /* List of ExecRowMarks */
1693         EPQState        lr_epqstate;    /* for evaluating EvalPlanQual rechecks */
1694 } LockRowsState;
1695
1696 /* ----------------
1697  *       LimitState information
1698  *
1699  *              Limit nodes are used to enforce LIMIT/OFFSET clauses.
1700  *              They just select the desired subrange of their subplan's output.
1701  *
1702  * offset is the number of initial tuples to skip (0 does nothing).
1703  * count is the number of tuples to return after skipping the offset tuples.
1704  * If no limit count was specified, count is undefined and noCount is true.
1705  * When lstate == LIMIT_INITIAL, offset/count/noCount haven't been set yet.
1706  * ----------------
1707  */
1708 typedef enum
1709 {
1710         LIMIT_INITIAL,                          /* initial state for LIMIT node */
1711         LIMIT_RESCAN,                           /* rescan after recomputing parameters */
1712         LIMIT_EMPTY,                            /* there are no returnable rows */
1713         LIMIT_INWINDOW,                         /* have returned a row in the window */
1714         LIMIT_SUBPLANEOF,                       /* at EOF of subplan (within window) */
1715         LIMIT_WINDOWEND,                        /* stepped off end of window */
1716         LIMIT_WINDOWSTART                       /* stepped off beginning of window */
1717 } LimitStateCond;
1718
1719 typedef struct LimitState
1720 {
1721         PlanState       ps;                             /* its first field is NodeTag */
1722         ExprState  *limitOffset;        /* OFFSET parameter, or NULL if none */
1723         ExprState  *limitCount;         /* COUNT parameter, or NULL if none */
1724         int64           offset;                 /* current OFFSET value */
1725         int64           count;                  /* current COUNT, if any */
1726         bool            noCount;                /* if true, ignore count */
1727         LimitStateCond lstate;          /* state machine status, as above */
1728         int64           position;               /* 1-based index of last tuple returned */
1729         TupleTableSlot *subSlot;        /* tuple last obtained from subplan */
1730 } LimitState;
1731
1732 #endif   /* EXECNODES_H */