setrefs.c 52.0 KB
Newer Older
1 2
/*-------------------------------------------------------------------------
 *
3
 * setrefs.c
4
 *	  Post-processing of a completed plan tree: fix references to subplan
5
 *	  vars, compute regproc values for operators, etc
6
 *
7
 * Portions Copyright (c) 1996-2010, PostgreSQL Global Development Group
B
Add:  
Bruce Momjian 已提交
8
 * Portions Copyright (c) 1994, Regents of the University of California
9 10 11
 *
 *
 * IDENTIFICATION
12
 *	  src/backend/optimizer/plan/setrefs.c
13 14 15 16 17
 *
 *-------------------------------------------------------------------------
 */
#include "postgres.h"

18
#include "access/transam.h"
19
#include "catalog/pg_type.h"
20
#include "nodes/makefuncs.h"
21
#include "nodes/nodeFuncs.h"
22 23 24
#include "optimizer/clauses.h"
#include "optimizer/planmain.h"
#include "optimizer/tlist.h"
25
#include "parser/parsetree.h"
26
#include "utils/lsyscache.h"
27
#include "utils/syscache.h"
28

29

30 31 32 33 34 35 36 37 38 39 40
typedef struct
{
	Index		varno;			/* RT index of Var */
	AttrNumber	varattno;		/* attr number of Var */
	AttrNumber	resno;			/* TLE position of Var */
} tlist_vinfo;

typedef struct
{
	List	   *tlist;			/* underlying target list */
	int			num_vars;		/* number of plain Var tlist entries */
41 42
	bool		has_ph_vars;	/* are there PlaceHolderVar entries? */
	bool		has_non_vars;	/* are there other entries? */
43
	/* array of num_vars entries: */
B
Bruce Momjian 已提交
44
	tlist_vinfo vars[1];		/* VARIABLE LENGTH ARRAY */
45 46
} indexed_tlist;				/* VARIABLE LENGTH STRUCT */

47 48
typedef struct
{
49
	PlannerGlobal *glob;
50
	int			rtoffset;
51
} fix_scan_expr_context;
52

53 54
typedef struct
{
55
	PlannerGlobal *glob;
56 57
	indexed_tlist *outer_itlist;
	indexed_tlist *inner_itlist;
58
	Index		acceptable_rel;
59
	int			rtoffset;
60
} fix_join_expr_context;
61

62 63
typedef struct
{
64
	PlannerGlobal *glob;
65
	indexed_tlist *subplan_itlist;
66
	int			rtoffset;
67
} fix_upper_expr_context;
68

69 70 71 72 73 74 75 76 77 78 79
/*
 * Check if a Const node is a regclass value.  We accept plain OID too,
 * since a regclass Const will get folded to that type if it's an argument
 * to oideq or similar operators.  (This might result in some extraneous
 * values in a plan's list of relation dependencies, but the worst result
 * would be occasional useless replans.)
 */
#define ISREGCLASSCONST(con) \
	(((con)->consttype == REGCLASSOID || (con)->consttype == OIDOID) && \
	 !(con)->constisnull)

80 81
#define fix_scan_list(glob, lst, rtoffset) \
	((List *) fix_scan_expr(glob, (Node *) (lst), rtoffset))
82

83 84
static Plan *set_plan_refs(PlannerGlobal *glob, Plan *plan, int rtoffset);
static Plan *set_subqueryscan_references(PlannerGlobal *glob,
B
Bruce Momjian 已提交
85 86
							SubqueryScan *plan,
							int rtoffset);
87
static bool trivial_subqueryscan(SubqueryScan *plan);
88 89
static Node *fix_scan_expr(PlannerGlobal *glob, Node *node, int rtoffset);
static Node *fix_scan_expr_mutator(Node *node, fix_scan_expr_context *context);
90
static bool fix_scan_expr_walker(Node *node, fix_scan_expr_context *context);
91 92
static void set_join_references(PlannerGlobal *glob, Join *join, int rtoffset);
static void set_upper_references(PlannerGlobal *glob, Plan *plan, int rtoffset);
93
static void set_dummy_tlist_references(Plan *plan, int rtoffset);
94 95
static indexed_tlist *build_tlist_index(List *tlist);
static Var *search_indexed_tlist_for_var(Var *var,
B
Bruce Momjian 已提交
96
							 indexed_tlist *itlist,
97 98
							 Index newvarno,
							 int rtoffset);
99
static Var *search_indexed_tlist_for_non_var(Node *node,
B
Bruce Momjian 已提交
100 101
								 indexed_tlist *itlist,
								 Index newvarno);
102 103 104 105
static Var *search_indexed_tlist_for_sortgroupref(Node *node,
									  Index sortgroupref,
									  indexed_tlist *itlist,
									  Index newvarno);
106
static List *fix_join_expr(PlannerGlobal *glob,
B
Bruce Momjian 已提交
107 108 109 110
			  List *clauses,
			  indexed_tlist *outer_itlist,
			  indexed_tlist *inner_itlist,
			  Index acceptable_rel, int rtoffset);
111
static Node *fix_join_expr_mutator(Node *node,
112 113
					  fix_join_expr_context *context);
static Node *fix_upper_expr(PlannerGlobal *glob,
B
Bruce Momjian 已提交
114 115 116
			   Node *node,
			   indexed_tlist *subplan_itlist,
			   int rtoffset);
117
static Node *fix_upper_expr_mutator(Node *node,
118
					   fix_upper_expr_context *context);
119
static bool fix_opfuncids_walker(Node *node, void *context);
120
static bool extract_query_dependencies_walker(Node *node,
121
								  PlannerGlobal *context);
122

123 124

/*****************************************************************************
125 126 127
 *
 *		SUBPLAN REFERENCES
 *
128 129
 *****************************************************************************/

130
/*
131
 * set_plan_references
132
 *
B
Bruce Momjian 已提交
133
 * This is the final processing pass of the planner/optimizer.	The plan
134
 * tree is complete; we just have to adjust some representational details
135 136 137 138 139 140 141 142 143 144 145 146
 * for the convenience of the executor:
 *
 * 1. We flatten the various subquery rangetables into a single list, and
 * zero out RangeTblEntry fields that are not useful to the executor.
 *
 * 2. We adjust Vars in scan nodes to be consistent with the flat rangetable.
 *
 * 3. We adjust Vars in upper plan nodes to refer to the outputs of their
 * subplans.
 *
 * 4. We compute regproc OIDs for operators (ie, we look up the function
 * that implements each op).
147
 *
148
 * 5. We create lists of specific objects that the plan depends on.
149
 * This will be used by plancache.c to drive invalidation of cached plans.
150 151 152 153
 * Relation dependencies are represented by OIDs, and everything else by
 * PlanInvalItems (this distinction is motivated by the shared-inval APIs).
 * Currently, relations and user-defined functions are the only types of
 * objects that are explicitly tracked this way.
154
 *
155 156 157 158
 * We also perform one final optimization step, which is to delete
 * SubqueryScan plan nodes that aren't doing anything useful (ie, have
 * no qual and a no-op targetlist).  The reason for doing this last is that
 * it can't readily be done before set_plan_references, because it would
159 160
 * break set_upper_references: the Vars in the subquery's top tlist
 * wouldn't match up with the Vars in the outer plan tree.  The SubqueryScan
161
 * serves a necessary function as a buffer between outer query and subquery
162
 * variable numbering ... but after we've flattened the rangetable this is
163
 * no longer a problem, since then there's only one rtindex namespace.
164 165 166
 *
 * set_plan_references recursively traverses the whole plan tree.
 *
167 168 169 170
 * Inputs:
 *	glob: global data for planner run
 *	plan: the topmost node of the plan
 *	rtable: the rangetable for the current subquery
171
 *	rowmarks: the PlanRowMark list for the current subquery
172
 *
173 174 175
 * The return value is normally the same Plan node passed in, but can be
 * different when the passed-in Plan is a SubqueryScan we decide isn't needed.
 *
176 177 178
 * The flattened rangetable entries are appended to glob->finalrtable,
 * and we also append rowmarks entries to glob->finalrowmarks.
 * Plan dependencies are appended to glob->relationOids (for relations)
179
 * and glob->invalItems (for everything else).
180 181
 *
 * Notice that we modify Plan nodes in-place, but use expression_tree_mutator
B
Bruce Momjian 已提交
182
 * to process targetlist and qual expressions.	We can assume that the Plan
183 184
 * nodes were just built by the planner and are not multiply referenced, but
 * it's not so safe to assume that for expression tree nodes.
185
 */
186
Plan *
187 188
set_plan_references(PlannerGlobal *glob, Plan *plan,
					List *rtable, List *rowmarks)
189 190 191 192 193
{
	int			rtoffset = list_length(glob->finalrtable);
	ListCell   *lc;

	/*
B
Bruce Momjian 已提交
194 195 196
	 * In the flat rangetable, we zero out substructure pointers that are not
	 * needed by the executor; this reduces the storage space and copying cost
	 * for cached plans.  We keep only the alias and eref Alias fields, which
197
	 * are needed by EXPLAIN, and the selectedCols and modifiedCols bitmaps,
198 199
	 * which are needed for executor-startup permissions checking and for
	 * trigger event checking.
200 201 202
	 */
	foreach(lc, rtable)
	{
B
Bruce Momjian 已提交
203 204
		RangeTblEntry *rte = (RangeTblEntry *) lfirst(lc);
		RangeTblEntry *newrte;
205 206 207 208 209

		/* flat copy to duplicate all the scalar fields */
		newrte = (RangeTblEntry *) palloc(sizeof(RangeTblEntry));
		memcpy(newrte, rte, sizeof(RangeTblEntry));

210
		/* zap unneeded sub-structure */
211
		newrte->subquery = NULL;
212
		newrte->joinaliasvars = NIL;
213 214 215 216
		newrte->funcexpr = NULL;
		newrte->funccoltypes = NIL;
		newrte->funccoltypmods = NIL;
		newrte->values_lists = NIL;
217 218
		newrte->ctecoltypes = NIL;
		newrte->ctecoltypmods = NIL;
219 220

		glob->finalrtable = lappend(glob->finalrtable, newrte);
221 222 223 224

		/*
		 * If it's a plain relation RTE, add the table to relationOids.
		 *
B
Bruce Momjian 已提交
225 226 227 228 229
		 * We do this even though the RTE might be unreferenced in the plan
		 * tree; this would correspond to cases such as views that were
		 * expanded, child tables that were eliminated by constraint
		 * exclusion, etc.	Schema invalidation on such a rel must still force
		 * rebuilding of the plan.
230 231 232 233 234 235 236
		 *
		 * Note we don't bother to avoid duplicate list entries.  We could,
		 * but it would probably cost more cycles than it would save.
		 */
		if (newrte->rtekind == RTE_RELATION)
			glob->relationOids = lappend_oid(glob->relationOids,
											 newrte->relid);
237 238
	}

239
	/*
240
	 * Adjust RT indexes of PlanRowMarks and add to final rowmarks list
241 242 243
	 */
	foreach(lc, rowmarks)
	{
244 245
		PlanRowMark *rc = (PlanRowMark *) lfirst(lc);
		PlanRowMark *newrc;
246

247 248 249 250 251
		Assert(IsA(rc, PlanRowMark));

		/* flat copy is enough since all fields are scalars */
		newrc = (PlanRowMark *) palloc(sizeof(PlanRowMark));
		memcpy(newrc, rc, sizeof(PlanRowMark));
252 253 254 255 256 257 258 259

		/* adjust indexes */
		newrc->rti += rtoffset;
		newrc->prti += rtoffset;

		glob->finalrowmarks = lappend(glob->finalrowmarks, newrc);
	}

260 261 262 263 264 265 266 267
	/* Now fix the Plan tree */
	return set_plan_refs(glob, plan, rtoffset);
}

/*
 * set_plan_refs: recurse through the Plan nodes of a single subquery level
 */
static Plan *
268
set_plan_refs(PlannerGlobal *glob, Plan *plan, int rtoffset)
269
{
B
Bruce Momjian 已提交
270
	ListCell   *l;
271

272
	if (plan == NULL)
273
		return NULL;
274

275 276 277 278 279 280
	/*
	 * Plan-type-specific fixes
	 */
	switch (nodeTag(plan))
	{
		case T_SeqScan:
281
			{
B
Bruce Momjian 已提交
282
				SeqScan    *splan = (SeqScan *) plan;
283 284 285

				splan->scanrelid += rtoffset;
				splan->plan.targetlist =
286
					fix_scan_list(glob, splan->plan.targetlist, rtoffset);
287
				splan->plan.qual =
288
					fix_scan_list(glob, splan->plan.qual, rtoffset);
289
			}
290 291
			break;
		case T_IndexScan:
292
			{
B
Bruce Momjian 已提交
293
				IndexScan  *splan = (IndexScan *) plan;
294 295 296

				splan->scan.scanrelid += rtoffset;
				splan->scan.plan.targetlist =
297
					fix_scan_list(glob, splan->scan.plan.targetlist, rtoffset);
298
				splan->scan.plan.qual =
299
					fix_scan_list(glob, splan->scan.plan.qual, rtoffset);
300
				splan->indexqual =
301
					fix_scan_list(glob, splan->indexqual, rtoffset);
302
				splan->indexqualorig =
303
					fix_scan_list(glob, splan->indexqualorig, rtoffset);
304
			}
305
			break;
306
		case T_BitmapIndexScan:
307 308 309 310 311 312 313 314
			{
				BitmapIndexScan *splan = (BitmapIndexScan *) plan;

				splan->scan.scanrelid += rtoffset;
				/* no need to fix targetlist and qual */
				Assert(splan->scan.plan.targetlist == NIL);
				Assert(splan->scan.plan.qual == NIL);
				splan->indexqual =
315
					fix_scan_list(glob, splan->indexqual, rtoffset);
316
				splan->indexqualorig =
317
					fix_scan_list(glob, splan->indexqualorig, rtoffset);
318
			}
319 320
			break;
		case T_BitmapHeapScan:
321 322 323 324 325
			{
				BitmapHeapScan *splan = (BitmapHeapScan *) plan;

				splan->scan.scanrelid += rtoffset;
				splan->scan.plan.targetlist =
326
					fix_scan_list(glob, splan->scan.plan.targetlist, rtoffset);
327
				splan->scan.plan.qual =
328
					fix_scan_list(glob, splan->scan.plan.qual, rtoffset);
329
				splan->bitmapqualorig =
330
					fix_scan_list(glob, splan->bitmapqualorig, rtoffset);
331
			}
332
			break;
333
		case T_TidScan:
334
			{
B
Bruce Momjian 已提交
335
				TidScan    *splan = (TidScan *) plan;
336 337 338

				splan->scan.scanrelid += rtoffset;
				splan->scan.plan.targetlist =
339
					fix_scan_list(glob, splan->scan.plan.targetlist, rtoffset);
340
				splan->scan.plan.qual =
341
					fix_scan_list(glob, splan->scan.plan.qual, rtoffset);
342
				splan->tidquals =
343
					fix_scan_list(glob, splan->tidquals, rtoffset);
344
			}
345
			break;
346
		case T_SubqueryScan:
347
			/* Needs special treatment, see comments below */
348 349 350
			return set_subqueryscan_references(glob,
											   (SubqueryScan *) plan,
											   rtoffset);
351
		case T_FunctionScan:
352 353 354 355 356
			{
				FunctionScan *splan = (FunctionScan *) plan;

				splan->scan.scanrelid += rtoffset;
				splan->scan.plan.targetlist =
357
					fix_scan_list(glob, splan->scan.plan.targetlist, rtoffset);
358
				splan->scan.plan.qual =
359
					fix_scan_list(glob, splan->scan.plan.qual, rtoffset);
360
				splan->funcexpr =
361
					fix_scan_expr(glob, splan->funcexpr, rtoffset);
362
			}
363
			break;
364
		case T_ValuesScan:
365 366 367 368 369
			{
				ValuesScan *splan = (ValuesScan *) plan;

				splan->scan.scanrelid += rtoffset;
				splan->scan.plan.targetlist =
370
					fix_scan_list(glob, splan->scan.plan.targetlist, rtoffset);
371
				splan->scan.plan.qual =
372
					fix_scan_list(glob, splan->scan.plan.qual, rtoffset);
373
				splan->values_lists =
374
					fix_scan_list(glob, splan->values_lists, rtoffset);
375
			}
376
			break;
377 378
		case T_CteScan:
			{
379
				CteScan    *splan = (CteScan *) plan;
380 381 382 383 384 385 386 387 388 389 390

				splan->scan.scanrelid += rtoffset;
				splan->scan.plan.targetlist =
					fix_scan_list(glob, splan->scan.plan.targetlist, rtoffset);
				splan->scan.plan.qual =
					fix_scan_list(glob, splan->scan.plan.qual, rtoffset);
			}
			break;
		case T_WorkTableScan:
			{
				WorkTableScan *splan = (WorkTableScan *) plan;
391

392 393 394 395 396 397 398
				splan->scan.scanrelid += rtoffset;
				splan->scan.plan.targetlist =
					fix_scan_list(glob, splan->scan.plan.targetlist, rtoffset);
				splan->scan.plan.qual =
					fix_scan_list(glob, splan->scan.plan.qual, rtoffset);
			}
			break;
399 400 401
		case T_NestLoop:
		case T_MergeJoin:
		case T_HashJoin:
402
			set_join_references(glob, (Join *) plan, rtoffset);
403
			break;
404

405
		case T_Hash:
406 407 408
		case T_Material:
		case T_Sort:
		case T_Unique:
409
		case T_SetOp:
410 411 412

			/*
			 * These plan types don't actually bother to evaluate their
413
			 * targetlists, because they just return their unmodified input
B
Bruce Momjian 已提交
414
			 * tuples.	Even though the targetlist won't be used by the
415 416 417
			 * executor, we fix it up for possible use by EXPLAIN (not to
			 * mention ease of debugging --- wrong varnos are very confusing).
			 */
418
			set_dummy_tlist_references(plan, rtoffset);
B
Bruce Momjian 已提交
419

420
			/*
B
Bruce Momjian 已提交
421 422
			 * Since these plan types don't check quals either, we should not
			 * find any qual expression attached to them.
423
			 */
424
			Assert(plan->qual == NIL);
425
			break;
426 427 428 429 430 431
		case T_LockRows:
			{
				LockRows   *splan = (LockRows *) plan;

				/*
				 * Like the plan types above, LockRows doesn't evaluate its
B
Bruce Momjian 已提交
432 433
				 * tlist or quals.	But we have to fix up the RT indexes in
				 * its rowmarks.
434 435 436 437 438 439
				 */
				set_dummy_tlist_references(plan, rtoffset);
				Assert(splan->plan.qual == NIL);

				foreach(l, splan->rowMarks)
				{
440
					PlanRowMark *rc = (PlanRowMark *) lfirst(l);
441 442 443 444 445 446

					rc->rti += rtoffset;
					rc->prti += rtoffset;
				}
			}
			break;
447
		case T_Limit:
448
			{
B
Bruce Momjian 已提交
449
				Limit	   *splan = (Limit *) plan;
450 451 452 453

				/*
				 * Like the plan types above, Limit doesn't evaluate its tlist
				 * or quals.  It does have live expressions for limit/offset,
B
Bruce Momjian 已提交
454 455
				 * however; and those cannot contain subplan variable refs, so
				 * fix_scan_expr works for them.
456
				 */
457
				set_dummy_tlist_references(plan, rtoffset);
458
				Assert(splan->plan.qual == NIL);
459

460
				splan->limitOffset =
461
					fix_scan_expr(glob, splan->limitOffset, rtoffset);
462
				splan->limitCount =
463
					fix_scan_expr(glob, splan->limitCount, rtoffset);
464
			}
465
			break;
466 467
		case T_Agg:
		case T_Group:
468
			set_upper_references(glob, plan, rtoffset);
469
			break;
470 471
		case T_WindowAgg:
			{
B
Bruce Momjian 已提交
472
				WindowAgg  *wplan = (WindowAgg *) plan;
473 474 475 476 477 478 479 480 481 482 483 484 485 486

				set_upper_references(glob, plan, rtoffset);

				/*
				 * Like Limit node limit/offset expressions, WindowAgg has
				 * frame offset expressions, which cannot contain subplan
				 * variable refs, so fix_scan_expr works for them.
				 */
				wplan->startOffset =
					fix_scan_expr(glob, wplan->startOffset, rtoffset);
				wplan->endOffset =
					fix_scan_expr(glob, wplan->endOffset, rtoffset);
			}
			break;
487
		case T_Result:
488
			{
B
Bruce Momjian 已提交
489
				Result	   *splan = (Result *) plan;
490 491 492 493 494 495

				/*
				 * Result may or may not have a subplan; if not, it's more
				 * like a scan node than an upper node.
				 */
				if (splan->plan.lefttree != NULL)
496
					set_upper_references(glob, plan, rtoffset);
497 498 499
				else
				{
					splan->plan.targetlist =
500
						fix_scan_list(glob, splan->plan.targetlist, rtoffset);
501
					splan->plan.qual =
502
						fix_scan_list(glob, splan->plan.qual, rtoffset);
503 504 505
				}
				/* resconstantqual can't contain any subplan variable refs */
				splan->resconstantqual =
506
					fix_scan_expr(glob, splan->resconstantqual, rtoffset);
507
			}
508
			break;
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
		case T_ModifyTable:
			{
				ModifyTable *splan = (ModifyTable *) plan;

				/*
				 * planner.c already called set_returning_clause_references,
				 * so we should not process either the targetlist or the
				 * returningLists.
				 */
				Assert(splan->plan.qual == NIL);

				foreach(l, splan->resultRelations)
				{
					lfirst_int(l) += rtoffset;
				}
524 525 526 527 528 529 530
				foreach(l, splan->rowMarks)
				{
					PlanRowMark *rc = (PlanRowMark *) lfirst(l);

					rc->rti += rtoffset;
					rc->prti += rtoffset;
				}
531 532 533 534 535 536 537 538
				foreach(l, splan->plans)
				{
					lfirst(l) = set_plan_refs(glob,
											  (Plan *) lfirst(l),
											  rtoffset);
				}
			}
			break;
539
		case T_Append:
540
			{
B
Bruce Momjian 已提交
541
				Append	   *splan = (Append *) plan;
542 543 544 545 546

				/*
				 * Append, like Sort et al, doesn't actually evaluate its
				 * targetlist or check quals.
				 */
547
				set_dummy_tlist_references(plan, rtoffset);
548 549 550 551 552 553 554 555
				Assert(splan->plan.qual == NIL);
				foreach(l, splan->appendplans)
				{
					lfirst(l) = set_plan_refs(glob,
											  (Plan *) lfirst(l),
											  rtoffset);
				}
			}
556
			break;
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
		case T_MergeAppend:
			{
				MergeAppend *splan = (MergeAppend *) plan;

				/*
				 * MergeAppend, like Sort et al, doesn't actually evaluate its
				 * targetlist or check quals.
				 */
				set_dummy_tlist_references(plan, rtoffset);
				Assert(splan->plan.qual == NIL);
				foreach(l, splan->mergeplans)
				{
					lfirst(l) = set_plan_refs(glob,
											  (Plan *) lfirst(l),
											  rtoffset);
				}
			}
			break;
575 576 577 578 579
		case T_RecursiveUnion:
			/* This doesn't evaluate targetlist or check quals either */
			set_dummy_tlist_references(plan, rtoffset);
			Assert(plan->qual == NIL);
			break;
580
		case T_BitmapAnd:
581
			{
B
Bruce Momjian 已提交
582
				BitmapAnd  *splan = (BitmapAnd *) plan;
583 584 585 586 587 588 589 590 591 592 593

				/* BitmapAnd works like Append, but has no tlist */
				Assert(splan->plan.targetlist == NIL);
				Assert(splan->plan.qual == NIL);
				foreach(l, splan->bitmapplans)
				{
					lfirst(l) = set_plan_refs(glob,
											  (Plan *) lfirst(l),
											  rtoffset);
				}
			}
594 595
			break;
		case T_BitmapOr:
596
			{
B
Bruce Momjian 已提交
597
				BitmapOr   *splan = (BitmapOr *) plan;
598 599 600 601 602 603 604 605 606 607 608

				/* BitmapOr works like Append, but has no tlist */
				Assert(splan->plan.targetlist == NIL);
				Assert(splan->plan.qual == NIL);
				foreach(l, splan->bitmapplans)
				{
					lfirst(l) = set_plan_refs(glob,
											  (Plan *) lfirst(l),
											  rtoffset);
				}
			}
609
			break;
610
		default:
611 612
			elog(ERROR, "unrecognized node type: %d",
				 (int) nodeTag(plan));
613 614
			break;
	}
615

616
	/*
617
	 * Now recurse into child plans, if any
618
	 *
619
	 * NOTE: it is essential that we recurse into child plans AFTER we set
620 621
	 * subplan references in this plan's tlist and quals.  If we did the
	 * reference-adjustments bottom-up, then we would fail to match this
B
Bruce Momjian 已提交
622
	 * plan's var nodes against the already-modified nodes of the children.
623
	 */
624 625
	plan->lefttree = set_plan_refs(glob, plan->lefttree, rtoffset);
	plan->righttree = set_plan_refs(glob, plan->righttree, rtoffset);
626 627 628 629 630 631 632 633 634 635 636 637

	return plan;
}

/*
 * set_subqueryscan_references
 *		Do set_plan_references processing on a SubqueryScan
 *
 * We try to strip out the SubqueryScan entirely; if we can't, we have
 * to do the normal processing on it.
 */
static Plan *
638
set_subqueryscan_references(PlannerGlobal *glob,
639 640
							SubqueryScan *plan,
							int rtoffset)
641 642 643 644
{
	Plan	   *result;

	/* First, recursively process the subplan */
645 646
	plan->subplan = set_plan_references(glob, plan->subplan,
										plan->subrtable, plan->subrowmark);
647

648
	/* subrtable/subrowmark are no longer needed in the plan tree */
649
	plan->subrtable = NIL;
650
	plan->subrowmark = NIL;
651 652 653 654

	if (trivial_subqueryscan(plan))
	{
		/*
655
		 * We can omit the SubqueryScan node and just pull up the subplan.
656
		 */
657 658
		ListCell   *lp,
				   *lc;
659

660
		result = plan->subplan;
661

662
		/* We have to be sure we don't lose any initplans */
663 664
		result->initPlan = list_concat(plan->scan.plan.initPlan,
									   result->initPlan);
665 666

		/*
667
		 * We also have to transfer the SubqueryScan's result-column names
668
		 * into the subplan, else columns sent to client will be improperly
669 670
		 * labeled if this is the topmost plan level.  Copy the "source
		 * column" information too.
671 672 673 674 675 676 677
		 */
		forboth(lp, plan->scan.plan.targetlist, lc, result->targetlist)
		{
			TargetEntry *ptle = (TargetEntry *) lfirst(lp);
			TargetEntry *ctle = (TargetEntry *) lfirst(lc);

			ctle->resname = ptle->resname;
678 679
			ctle->resorigtbl = ptle->resorigtbl;
			ctle->resorigcol = ptle->resorigcol;
680
		}
681 682 683 684
	}
	else
	{
		/*
B
Bruce Momjian 已提交
685 686
		 * Keep the SubqueryScan node.	We have to do the processing that
		 * set_plan_references would otherwise have done on it.  Notice we do
687
		 * not do set_upper_references() here, because a SubqueryScan will
B
Bruce Momjian 已提交
688 689
		 * always have been created with correct references to its subplan's
		 * outputs to begin with.
690
		 */
691 692
		plan->scan.scanrelid += rtoffset;
		plan->scan.plan.targetlist =
693
			fix_scan_list(glob, plan->scan.plan.targetlist, rtoffset);
694
		plan->scan.plan.qual =
695
			fix_scan_list(glob, plan->scan.plan.qual, rtoffset);
696

697
		result = (Plan *) plan;
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
	}

	return result;
}

/*
 * trivial_subqueryscan
 *		Detect whether a SubqueryScan can be deleted from the plan tree.
 *
 * We can delete it if it has no qual to check and the targetlist just
 * regurgitates the output of the child plan.
 */
static bool
trivial_subqueryscan(SubqueryScan *plan)
{
	int			attrno;
	ListCell   *lp,
			   *lc;

	if (plan->scan.plan.qual != NIL)
		return false;

720 721 722 723
	if (list_length(plan->scan.plan.targetlist) !=
		list_length(plan->subplan->targetlist))
		return false;			/* tlists not same length */

724 725 726 727 728 729 730 731
	attrno = 1;
	forboth(lp, plan->scan.plan.targetlist, lc, plan->subplan->targetlist)
	{
		TargetEntry *ptle = (TargetEntry *) lfirst(lp);
		TargetEntry *ctle = (TargetEntry *) lfirst(lc);

		if (ptle->resjunk != ctle->resjunk)
			return false;		/* tlist doesn't match junk status */
732 733

		/*
B
Bruce Momjian 已提交
734 735 736
		 * We accept either a Var referencing the corresponding element of the
		 * subplan tlist, or a Const equaling the subplan element. See
		 * generate_setop_tlist() for motivation.
737 738 739
		 */
		if (ptle->expr && IsA(ptle->expr, Var))
		{
B
Bruce Momjian 已提交
740
			Var		   *var = (Var *) ptle->expr;
741 742 743 744 745 746 747 748 749 750 751 752 753 754

			Assert(var->varno == plan->scan.scanrelid);
			Assert(var->varlevelsup == 0);
			if (var->varattno != attrno)
				return false;	/* out of order */
		}
		else if (ptle->expr && IsA(ptle->expr, Const))
		{
			if (!equal(ptle->expr, ctle->expr))
				return false;
		}
		else
			return false;

755 756 757 758 759 760
		attrno++;
	}

	return true;
}

761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
/*
 * copyVar
 *		Copy a Var node.
 *
 * fix_scan_expr and friends do this enough times that it's worth having
 * a bespoke routine instead of using the generic copyObject() function.
 */
static inline Var *
copyVar(Var *var)
{
	Var		   *newvar = (Var *) palloc(sizeof(Var));

	*newvar = *var;
	return newvar;
}

777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
/*
 * fix_expr_common
 *		Do generic set_plan_references processing on an expression node
 *
 * This is code that is common to all variants of expression-fixing.
 * We must look up operator opcode info for OpExpr and related nodes,
 * add OIDs from regclass Const nodes into glob->relationOids,
 * and add catalog TIDs for user-defined functions into glob->invalItems.
 *
 * We assume it's okay to update opcode info in-place.  So this could possibly
 * scribble on the planner's input data structures, but it's OK.
 */
static void
fix_expr_common(PlannerGlobal *glob, Node *node)
{
	/* We assume callers won't call us on a NULL pointer */
	if (IsA(node, Aggref))
	{
		record_plan_function_dependency(glob,
										((Aggref *) node)->aggfnoid);
	}
T
Tom Lane 已提交
798 799 800 801 802
	else if (IsA(node, WindowFunc))
	{
		record_plan_function_dependency(glob,
										((WindowFunc *) node)->winfnoid);
	}
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
	else if (IsA(node, FuncExpr))
	{
		record_plan_function_dependency(glob,
										((FuncExpr *) node)->funcid);
	}
	else if (IsA(node, OpExpr))
	{
		set_opfuncid((OpExpr *) node);
		record_plan_function_dependency(glob,
										((OpExpr *) node)->opfuncid);
	}
	else if (IsA(node, DistinctExpr))
	{
		set_opfuncid((OpExpr *) node);	/* rely on struct equivalence */
		record_plan_function_dependency(glob,
										((DistinctExpr *) node)->opfuncid);
	}
	else if (IsA(node, NullIfExpr))
	{
		set_opfuncid((OpExpr *) node);	/* rely on struct equivalence */
		record_plan_function_dependency(glob,
										((NullIfExpr *) node)->opfuncid);
	}
	else if (IsA(node, ScalarArrayOpExpr))
	{
		set_sa_opfuncid((ScalarArrayOpExpr *) node);
		record_plan_function_dependency(glob,
830
									 ((ScalarArrayOpExpr *) node)->opfuncid);
831 832 833 834 835
	}
	else if (IsA(node, ArrayCoerceExpr))
	{
		if (OidIsValid(((ArrayCoerceExpr *) node)->elemfuncid))
			record_plan_function_dependency(glob,
836
									 ((ArrayCoerceExpr *) node)->elemfuncid);
837 838 839 840 841 842 843 844 845 846 847 848 849
	}
	else if (IsA(node, Const))
	{
		Const	   *con = (Const *) node;

		/* Check for regclass reference */
		if (ISREGCLASSCONST(con))
			glob->relationOids =
				lappend_oid(glob->relationOids,
							DatumGetObjectId(con->constvalue));
	}
}

850
/*
851 852
 * fix_scan_expr
 *		Do set_plan_references processing on a scan-level expression
853
 *
854 855 856
 * This consists of incrementing all Vars' varnos by rtoffset,
 * looking up operator opcode info for OpExpr and related nodes,
 * and adding OIDs from regclass Const nodes into glob->relationOids.
857
 */
858
static Node *
859
fix_scan_expr(PlannerGlobal *glob, Node *node, int rtoffset)
860
{
861 862
	fix_scan_expr_context context;

863
	context.glob = glob;
864
	context.rtoffset = rtoffset;
865

866
	if (rtoffset != 0 || glob->lastPHId != 0)
867 868 869 870 871 872
	{
		return fix_scan_expr_mutator(node, &context);
	}
	else
	{
		/*
873 874 875
		 * If rtoffset == 0, we don't need to change any Vars, and if there
		 * are no placeholders anywhere we won't need to remove them.  Then
		 * it's OK to just scribble on the input node tree instead of copying
876 877
		 * (since the only change, filling in any unset opfuncid fields, is
		 * harmless).  This saves just enough cycles to be noticeable on
878 879 880 881 882
		 * trivial queries.
		 */
		(void) fix_scan_expr_walker(node, &context);
		return node;
	}
883 884
}

885
static Node *
886
fix_scan_expr_mutator(Node *node, fix_scan_expr_context *context)
887 888
{
	if (node == NULL)
889
		return NULL;
890 891
	if (IsA(node, Var))
	{
892
		Var		   *var = copyVar((Var *) node);
893 894

		Assert(var->varlevelsup == 0);
B
Bruce Momjian 已提交
895

896
		/*
897
		 * We should not see any Vars marked INNER or OUTER.
898 899
		 */
		Assert(var->varno != INNER);
900 901
		Assert(var->varno != OUTER);
		var->varno += context->rtoffset;
902
		if (var->varnoold > 0)
903 904
			var->varnoold += context->rtoffset;
		return (Node *) var;
905
	}
906 907 908 909 910 911 912 913 914
	if (IsA(node, CurrentOfExpr))
	{
		CurrentOfExpr *cexpr = (CurrentOfExpr *) copyObject(node);

		Assert(cexpr->cvarno != INNER);
		Assert(cexpr->cvarno != OUTER);
		cexpr->cvarno += context->rtoffset;
		return (Node *) cexpr;
	}
915 916 917 918 919 920 921
	if (IsA(node, PlaceHolderVar))
	{
		/* At scan level, we should always just evaluate the contained expr */
		PlaceHolderVar *phv = (PlaceHolderVar *) node;

		return fix_scan_expr_mutator((Node *) phv->phexpr, context);
	}
922
	fix_expr_common(context->glob, node);
923 924
	return expression_tree_mutator(node, fix_scan_expr_mutator,
								   (void *) context);
925 926
}

927 928 929 930 931
static bool
fix_scan_expr_walker(Node *node, fix_scan_expr_context *context)
{
	if (node == NULL)
		return false;
932
	Assert(!IsA(node, PlaceHolderVar));
933
	fix_expr_common(context->glob, node);
934 935 936 937
	return expression_tree_walker(node, fix_scan_expr_walker,
								  (void *) context);
}

938
/*
939
 * set_join_references
940
 *	  Modify the target list and quals of a join node to reference its
941 942
 *	  subplans, by setting the varnos to OUTER or INNER and setting attno
 *	  values to the result domain number of either the corresponding outer
943
 *	  or inner join tuple item.  Also perform opcode lookup for these
944
 *	  expressions. and add regclass OIDs to glob->relationOids.
945 946
 */
static void
947
set_join_references(PlannerGlobal *glob, Join *join, int rtoffset)
948
{
949 950
	Plan	   *outer_plan = join->plan.lefttree;
	Plan	   *inner_plan = join->plan.righttree;
951 952
	indexed_tlist *outer_itlist;
	indexed_tlist *inner_itlist;
953

954 955
	outer_itlist = build_tlist_index(outer_plan->targetlist);
	inner_itlist = build_tlist_index(inner_plan->targetlist);
956

957
	/* All join plans have tlist, qual, and joinqual */
958 959
	join->plan.targetlist = fix_join_expr(glob,
										  join->plan.targetlist,
960 961 962 963
										  outer_itlist,
										  inner_itlist,
										  (Index) 0,
										  rtoffset);
964 965
	join->plan.qual = fix_join_expr(glob,
									join->plan.qual,
966 967 968 969
									outer_itlist,
									inner_itlist,
									(Index) 0,
									rtoffset);
970 971
	join->joinqual = fix_join_expr(glob,
								   join->joinqual,
972 973 974 975
								   outer_itlist,
								   inner_itlist,
								   (Index) 0,
								   rtoffset);
976 977 978 979

	/* Now do join-type-specific stuff */
	if (IsA(join, NestLoop))
	{
980 981 982 983 984 985 986 987 988 989 990 991
		NestLoop   *nl = (NestLoop *) join;
		ListCell   *lc;

		foreach(lc, nl->nestParams)
		{
			NestLoopParam *nlp = (NestLoopParam *) lfirst(lc);

			nlp->paramval = (Var *) fix_upper_expr(glob,
												   (Node *) nlp->paramval,
												   outer_itlist,
												   rtoffset);
		}
992 993 994 995 996
	}
	else if (IsA(join, MergeJoin))
	{
		MergeJoin  *mj = (MergeJoin *) join;

997 998
		mj->mergeclauses = fix_join_expr(glob,
										 mj->mergeclauses,
999 1000 1001 1002
										 outer_itlist,
										 inner_itlist,
										 (Index) 0,
										 rtoffset);
1003 1004 1005 1006 1007
	}
	else if (IsA(join, HashJoin))
	{
		HashJoin   *hj = (HashJoin *) join;

1008 1009
		hj->hashclauses = fix_join_expr(glob,
										hj->hashclauses,
1010 1011 1012 1013
										outer_itlist,
										inner_itlist,
										(Index) 0,
										rtoffset);
1014
	}
1015 1016 1017

	pfree(outer_itlist);
	pfree(inner_itlist);
1018 1019
}

1020
/*
1021
 * set_upper_references
1022 1023
 *	  Update the targetlist and quals of an upper-level plan node
 *	  to refer to the tuples returned by its lefttree subplan.
1024 1025
 *	  Also perform opcode lookup for these expressions, and
 *	  add regclass OIDs to glob->relationOids.
1026
 *
1027
 * This is used for single-input plan types like Agg, Group, Result.
1028 1029 1030 1031 1032
 *
 * In most cases, we have to match up individual Vars in the tlist and
 * qual expressions with elements of the subplan's tlist (which was
 * generated by flatten_tlist() from these selfsame expressions, so it
 * should have all the required variables).  There is an important exception,
1033 1034 1035 1036
 * however: GROUP BY and ORDER BY expressions will have been pushed into the
 * subplan tlist unflattened.  If these values are also needed in the output
 * then we want to reference the subplan tlist element rather than recomputing
 * the expression.
1037 1038
 */
static void
1039
set_upper_references(PlannerGlobal *glob, Plan *plan, int rtoffset)
1040
{
1041
	Plan	   *subplan = plan->lefttree;
1042 1043
	indexed_tlist *subplan_itlist;
	List	   *output_targetlist;
1044
	ListCell   *l;
1045

1046
	subplan_itlist = build_tlist_index(subplan->targetlist);
1047 1048 1049 1050 1051 1052 1053

	output_targetlist = NIL;
	foreach(l, plan->targetlist)
	{
		TargetEntry *tle = (TargetEntry *) lfirst(l);
		Node	   *newexpr;

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
		/* If it's a non-Var sort/group item, first try to match by sortref */
		if (tle->ressortgroupref != 0 && !IsA(tle->expr, Var))
		{
			newexpr = (Node *)
				search_indexed_tlist_for_sortgroupref((Node *) tle->expr,
													  tle->ressortgroupref,
													  subplan_itlist,
													  OUTER);
			if (!newexpr)
				newexpr = fix_upper_expr(glob,
										 (Node *) tle->expr,
										 subplan_itlist,
										 rtoffset);
		}
		else
			newexpr = fix_upper_expr(glob,
									 (Node *) tle->expr,
									 subplan_itlist,
									 rtoffset);
1073 1074 1075
		tle = flatCopyTargetEntry(tle);
		tle->expr = (Expr *) newexpr;
		output_targetlist = lappend(output_targetlist, tle);
1076 1077
	}
	plan->targetlist = output_targetlist;
1078 1079

	plan->qual = (List *)
1080 1081
		fix_upper_expr(glob,
					   (Node *) plan->qual,
1082 1083
					   subplan_itlist,
					   rtoffset);
1084 1085

	pfree(subplan_itlist);
1086 1087
}

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
/*
 * set_dummy_tlist_references
 *	  Replace the targetlist of an upper-level plan node with a simple
 *	  list of OUTER references to its child.
 *
 * This is used for plan types like Sort and Append that don't evaluate
 * their targetlists.  Although the executor doesn't care at all what's in
 * the tlist, EXPLAIN needs it to be realistic.
 *
 * Note: we could almost use set_upper_references() here, but it fails for
 * Append for lack of a lefttree subplan.  Single-purpose code is faster
 * anyway.
 */
static void
set_dummy_tlist_references(Plan *plan, int rtoffset)
{
	List	   *output_targetlist;
	ListCell   *l;

	output_targetlist = NIL;
	foreach(l, plan->targetlist)
	{
		TargetEntry *tle = (TargetEntry *) lfirst(l);
		Var		   *oldvar = (Var *) tle->expr;
		Var		   *newvar;

		newvar = makeVar(OUTER,
						 tle->resno,
						 exprType((Node *) oldvar),
						 exprTypmod((Node *) oldvar),
						 0);
		if (IsA(oldvar, Var))
		{
			newvar->varnoold = oldvar->varno + rtoffset;
			newvar->varoattno = oldvar->varattno;
		}
		else
		{
B
Bruce Momjian 已提交
1126
			newvar->varnoold = 0;		/* wasn't ever a plain Var */
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
			newvar->varoattno = 0;
		}

		tle = flatCopyTargetEntry(tle);
		tle->expr = (Expr *) newvar;
		output_targetlist = lappend(output_targetlist, tle);
	}
	plan->targetlist = output_targetlist;

	/* We don't touch plan->qual here */
}


1140
/*
1141
 * build_tlist_index --- build an index data structure for a child tlist
1142
 *
1143 1144
 * In most cases, subplan tlists will be "flat" tlists with only Vars,
 * so we try to optimize that case by extracting information about Vars
B
Bruce Momjian 已提交
1145
 * in advance.	Matching a parent tlist to a child is still an O(N^2)
1146 1147 1148 1149 1150 1151
 * operation, but at least with a much smaller constant factor than plain
 * tlist_member() searches.
 *
 * The result of this function is an indexed_tlist struct to pass to
 * search_indexed_tlist_for_var() or search_indexed_tlist_for_non_var().
 * When done, the indexed_tlist may be freed with a single pfree().
1152
 */
1153 1154
static indexed_tlist *
build_tlist_index(List *tlist)
1155
{
1156 1157
	indexed_tlist *itlist;
	tlist_vinfo *vinfo;
1158
	ListCell   *l;
1159

1160 1161 1162 1163 1164 1165
	/* Create data structure with enough slots for all tlist entries */
	itlist = (indexed_tlist *)
		palloc(offsetof(indexed_tlist, vars) +
			   list_length(tlist) * sizeof(tlist_vinfo));

	itlist->tlist = tlist;
1166
	itlist->has_ph_vars = false;
1167 1168 1169 1170
	itlist->has_non_vars = false;

	/* Find the Vars and fill in the index array */
	vinfo = itlist->vars;
1171 1172 1173 1174
	foreach(l, tlist)
	{
		TargetEntry *tle = (TargetEntry *) lfirst(l);

1175 1176
		if (tle->expr && IsA(tle->expr, Var))
		{
B
Bruce Momjian 已提交
1177
			Var		   *var = (Var *) tle->expr;
1178 1179 1180 1181 1182 1183

			vinfo->varno = var->varno;
			vinfo->varattno = var->varattno;
			vinfo->resno = tle->resno;
			vinfo++;
		}
1184 1185
		else if (tle->expr && IsA(tle->expr, PlaceHolderVar))
			itlist->has_ph_vars = true;
1186 1187 1188 1189 1190 1191 1192 1193 1194
		else
			itlist->has_non_vars = true;
	}

	itlist->num_vars = (vinfo - itlist->vars);

	return itlist;
}

1195 1196 1197 1198
/*
 * build_tlist_index_other_vars --- build a restricted tlist index
 *
 * This is like build_tlist_index, but we only index tlist entries that
1199 1200 1201
 * are Vars belonging to some rel other than the one specified.  We will set
 * has_ph_vars (allowing PlaceHolderVars to be matched), but not has_non_vars
 * (so nothing other than Vars and PlaceHolderVars can be matched).
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
 */
static indexed_tlist *
build_tlist_index_other_vars(List *tlist, Index ignore_rel)
{
	indexed_tlist *itlist;
	tlist_vinfo *vinfo;
	ListCell   *l;

	/* Create data structure with enough slots for all tlist entries */
	itlist = (indexed_tlist *)
		palloc(offsetof(indexed_tlist, vars) +
			   list_length(tlist) * sizeof(tlist_vinfo));

	itlist->tlist = tlist;
1216
	itlist->has_ph_vars = false;
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
	itlist->has_non_vars = false;

	/* Find the desired Vars and fill in the index array */
	vinfo = itlist->vars;
	foreach(l, tlist)
	{
		TargetEntry *tle = (TargetEntry *) lfirst(l);

		if (tle->expr && IsA(tle->expr, Var))
		{
			Var		   *var = (Var *) tle->expr;

			if (var->varno != ignore_rel)
			{
				vinfo->varno = var->varno;
				vinfo->varattno = var->varattno;
				vinfo->resno = tle->resno;
				vinfo++;
			}
		}
1237 1238
		else if (tle->expr && IsA(tle->expr, PlaceHolderVar))
			itlist->has_ph_vars = true;
1239 1240 1241 1242 1243 1244 1245
	}

	itlist->num_vars = (vinfo - itlist->vars);

	return itlist;
}

1246 1247 1248 1249 1250
/*
 * search_indexed_tlist_for_var --- find a Var in an indexed tlist
 *
 * If a match is found, return a copy of the given Var with suitably
 * modified varno/varattno (to wit, newvarno and the resno of the TLE entry).
1251
 * Also ensure that varnoold is incremented by rtoffset.
1252 1253 1254
 * If no match, return NULL.
 */
static Var *
1255 1256
search_indexed_tlist_for_var(Var *var, indexed_tlist *itlist,
							 Index newvarno, int rtoffset)
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
{
	Index		varno = var->varno;
	AttrNumber	varattno = var->varattno;
	tlist_vinfo *vinfo;
	int			i;

	vinfo = itlist->vars;
	i = itlist->num_vars;
	while (i-- > 0)
	{
		if (vinfo->varno == varno && vinfo->varattno == varattno)
		{
			/* Found a match */
1270
			Var		   *newvar = copyVar(var);
1271 1272 1273

			newvar->varno = newvarno;
			newvar->varattno = vinfo->resno;
1274 1275
			if (newvar->varnoold > 0)
				newvar->varnoold += rtoffset;
1276 1277 1278
			return newvar;
		}
		vinfo++;
1279
	}
1280 1281 1282 1283 1284 1285 1286 1287 1288
	return NULL;				/* no match */
}

/*
 * search_indexed_tlist_for_non_var --- find a non-Var in an indexed tlist
 *
 * If a match is found, return a Var constructed to reference the tlist item.
 * If no match, return NULL.
 *
1289 1290
 * NOTE: it is a waste of time to call this unless itlist->has_ph_vars or
 * itlist->has_non_vars
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
 */
static Var *
search_indexed_tlist_for_non_var(Node *node,
								 indexed_tlist *itlist, Index newvarno)
{
	TargetEntry *tle;

	tle = tlist_member(node, itlist->tlist);
	if (tle)
	{
		/* Found a matching subplan output expression */
		Var		   *newvar;

1304
		newvar = makeVarFromTargetEntry(newvarno, tle);
B
Bruce Momjian 已提交
1305
		newvar->varnoold = 0;	/* wasn't ever a plain Var */
1306 1307 1308 1309
		newvar->varoattno = 0;
		return newvar;
	}
	return NULL;				/* no match */
1310 1311
}

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
/*
 * search_indexed_tlist_for_sortgroupref --- find a sort/group expression
 *		(which is assumed not to be just a Var)
 *
 * If a match is found, return a Var constructed to reference the tlist item.
 * If no match, return NULL.
 *
 * This is needed to ensure that we select the right subplan TLE in cases
 * where there are multiple textually-equal()-but-volatile sort expressions.
 * And it's also faster than search_indexed_tlist_for_non_var.
 */
static Var *
search_indexed_tlist_for_sortgroupref(Node *node,
									  Index sortgroupref,
									  indexed_tlist *itlist,
									  Index newvarno)
{
	ListCell   *lc;

	foreach(lc, itlist->tlist)
	{
		TargetEntry *tle = (TargetEntry *) lfirst(lc);

		/* The equal() check should be redundant, but let's be paranoid */
		if (tle->ressortgroupref == sortgroupref &&
			equal(node, tle->expr))
		{
			/* Found a matching subplan output expression */
			Var		   *newvar;

1342
			newvar = makeVarFromTargetEntry(newvarno, tle);
B
Bruce Momjian 已提交
1343
			newvar->varnoold = 0;		/* wasn't ever a plain Var */
1344 1345 1346 1347 1348 1349 1350
			newvar->varoattno = 0;
			return newvar;
		}
	}
	return NULL;				/* no match */
}

1351
/*
1352 1353
 * fix_join_expr
 *	   Create a new set of targetlist entries or join qual clauses by
1354 1355
 *	   changing the varno/varattno values of variables in the clauses
 *	   to reference target list values from the outer and inner join
1356 1357
 *	   relation target lists.  Also perform opcode lookup and add
 *	   regclass OIDs to glob->relationOids.
1358 1359 1360
 *
 * This is used in two different scenarios: a normal join clause, where
 * all the Vars in the clause *must* be replaced by OUTER or INNER references;
1361 1362 1363
 * and a RETURNING clause, which may contain both Vars of the target relation
 * and Vars of other relations.  In the latter case we want to replace the
 * other-relation Vars by OUTER references, while leaving target Vars alone.
1364 1365
 *
 * For a normal join, acceptable_rel should be zero so that any failure to
1366 1367
 * match a Var will be reported as an error.  For the RETURNING case, pass
 * inner_itlist = NULL and acceptable_rel = the ID of the target relation.
1368 1369
 *
 * 'clauses' is the targetlist or list of join clauses
1370 1371 1372
 * 'outer_itlist' is the indexed target list of the outer join relation
 * 'inner_itlist' is the indexed target list of the inner join relation,
 *		or NULL
1373
 * 'acceptable_rel' is either zero or the rangetable index of a relation
1374 1375
 *		whose Vars may appear in the clause without provoking an error
 * 'rtoffset': how much to increment varnoold by
1376
 *
1377
 * Returns the new expression tree.  The original clause structure is
1378
 * not modified.
1379
 */
1380
static List *
1381
fix_join_expr(PlannerGlobal *glob,
1382
			  List *clauses,
1383 1384 1385 1386
			  indexed_tlist *outer_itlist,
			  indexed_tlist *inner_itlist,
			  Index acceptable_rel,
			  int rtoffset)
1387
{
1388
	fix_join_expr_context context;
B
Bruce Momjian 已提交
1389

1390
	context.glob = glob;
1391 1392
	context.outer_itlist = outer_itlist;
	context.inner_itlist = inner_itlist;
1393
	context.acceptable_rel = acceptable_rel;
1394 1395
	context.rtoffset = rtoffset;
	return (List *) fix_join_expr_mutator((Node *) clauses, &context);
1396 1397
}

1398
static Node *
1399
fix_join_expr_mutator(Node *node, fix_join_expr_context *context)
1400
{
1401 1402
	Var		   *newvar;

1403 1404 1405 1406 1407
	if (node == NULL)
		return NULL;
	if (IsA(node, Var))
	{
		Var		   *var = (Var *) node;
1408

1409
		/* First look for the var in the input tlists */
1410 1411
		newvar = search_indexed_tlist_for_var(var,
											  context->outer_itlist,
1412 1413
											  OUTER,
											  context->rtoffset);
1414
		if (newvar)
1415
			return (Node *) newvar;
1416
		if (context->inner_itlist)
1417
		{
1418 1419
			newvar = search_indexed_tlist_for_var(var,
												  context->inner_itlist,
1420 1421
												  INNER,
												  context->rtoffset);
1422 1423
			if (newvar)
				return (Node *) newvar;
1424
		}
1425

1426
		/* If it's for acceptable_rel, adjust and return it */
1427
		if (var->varno == context->acceptable_rel)
1428
		{
1429
			var = copyVar(var);
1430 1431
			if (var->varnoold > 0)
				var->varnoold += context->rtoffset;
1432 1433
			return (Node *) var;
		}
1434 1435

		/* No referent found for Var */
1436
		elog(ERROR, "variable not found in subplan target lists");
1437
	}
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
	if (IsA(node, PlaceHolderVar))
	{
		PlaceHolderVar *phv = (PlaceHolderVar *) node;

		/* See if the PlaceHolderVar has bubbled up from a lower plan node */
		if (context->outer_itlist->has_ph_vars)
		{
			newvar = search_indexed_tlist_for_non_var((Node *) phv,
													  context->outer_itlist,
													  OUTER);
			if (newvar)
				return (Node *) newvar;
		}
		if (context->inner_itlist && context->inner_itlist->has_ph_vars)
		{
			newvar = search_indexed_tlist_for_non_var((Node *) phv,
													  context->inner_itlist,
													  INNER);
			if (newvar)
				return (Node *) newvar;
		}

		/* If not supplied by input plans, evaluate the contained expr */
		return fix_join_expr_mutator((Node *) phv->phexpr, context);
	}
1463
	/* Try matching more complex expressions too, if tlists have any */
1464
	if (context->outer_itlist->has_non_vars)
1465
	{
1466 1467 1468 1469
		newvar = search_indexed_tlist_for_non_var(node,
												  context->outer_itlist,
												  OUTER);
		if (newvar)
1470
			return (Node *) newvar;
1471 1472 1473 1474 1475 1476 1477
	}
	if (context->inner_itlist && context->inner_itlist->has_non_vars)
	{
		newvar = search_indexed_tlist_for_non_var(node,
												  context->inner_itlist,
												  INNER);
		if (newvar)
1478 1479
			return (Node *) newvar;
	}
1480
	fix_expr_common(context->glob, node);
1481
	return expression_tree_mutator(node,
1482
								   fix_join_expr_mutator,
1483
								   (void *) context);
1484 1485
}

1486
/*
1487 1488
 * fix_upper_expr
 *		Modifies an expression tree so that all Var nodes reference outputs
1489 1490
 *		of a subplan.  Also performs opcode lookup, and adds regclass OIDs to
 *		glob->relationOids.
1491 1492 1493
 *
 * This is used to fix up target and qual expressions of non-join upper-level
 * plan nodes.
1494
 *
1495 1496 1497
 * An error is raised if no matching var can be found in the subplan tlist
 * --- so this routine should only be applied to nodes whose subplans'
 * targetlists were generated via flatten_tlist() or some such method.
1498
 *
1499
 * If itlist->has_non_vars is true, then we try to match whole subexpressions
1500 1501 1502 1503 1504 1505
 * against elements of the subplan tlist, so that we can avoid recomputing
 * expressions that were already computed by the subplan.  (This is relatively
 * expensive, so we don't want to try it in the common case where the
 * subplan tlist is just a flattened list of Vars.)
 *
 * 'node': the tree to be fixed (a target item or qual)
1506
 * 'subplan_itlist': indexed target list for subplan
1507
 * 'rtoffset': how much to increment varnoold by
1508
 *
1509
 * The resulting tree is a copy of the original in which all Var nodes have
1510
 * varno = OUTER, varattno = resno of corresponding subplan target.
1511
 * The original tree is not modified.
1512
 */
1513
static Node *
1514
fix_upper_expr(PlannerGlobal *glob,
1515
			   Node *node,
1516 1517
			   indexed_tlist *subplan_itlist,
			   int rtoffset)
1518
{
1519
	fix_upper_expr_context context;
1520

1521
	context.glob = glob;
1522
	context.subplan_itlist = subplan_itlist;
1523 1524
	context.rtoffset = rtoffset;
	return fix_upper_expr_mutator(node, &context);
1525
}
B
Bruce Momjian 已提交
1526

1527
static Node *
1528
fix_upper_expr_mutator(Node *node, fix_upper_expr_context *context)
1529
{
1530 1531
	Var		   *newvar;

1532
	if (node == NULL)
1533
		return NULL;
1534 1535 1536
	if (IsA(node, Var))
	{
		Var		   *var = (Var *) node;
1537

1538 1539
		newvar = search_indexed_tlist_for_var(var,
											  context->subplan_itlist,
1540
											  OUTER,
1541
											  context->rtoffset);
1542
		if (!newvar)
1543
			elog(ERROR, "variable not found in subplan target list");
1544 1545
		return (Node *) newvar;
	}
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
	if (IsA(node, PlaceHolderVar))
	{
		PlaceHolderVar *phv = (PlaceHolderVar *) node;

		/* See if the PlaceHolderVar has bubbled up from a lower plan node */
		if (context->subplan_itlist->has_ph_vars)
		{
			newvar = search_indexed_tlist_for_non_var((Node *) phv,
													  context->subplan_itlist,
													  OUTER);
			if (newvar)
				return (Node *) newvar;
		}
		/* If not supplied by input plan, evaluate the contained expr */
		return fix_upper_expr_mutator((Node *) phv->phexpr, context);
	}
1562
	/* Try matching more complex expressions too, if tlist has any */
1563
	if (context->subplan_itlist->has_non_vars)
1564
	{
1565 1566
		newvar = search_indexed_tlist_for_non_var(node,
												  context->subplan_itlist,
1567
												  OUTER);
1568
		if (newvar)
1569 1570
			return (Node *) newvar;
	}
1571
	fix_expr_common(context->glob, node);
1572
	return expression_tree_mutator(node,
1573
								   fix_upper_expr_mutator,
1574
								   (void *) context);
1575 1576
}

1577 1578 1579 1580 1581 1582
/*
 * set_returning_clause_references
 *		Perform setrefs.c's work on a RETURNING targetlist
 *
 * If the query involves more than just the result table, we have to
 * adjust any Vars that refer to other tables to reference junk tlist
1583
 * entries in the top subplan's targetlist.  Vars referencing the result
1584
 * table should be left alone, however (the executor will evaluate them
B
Bruce Momjian 已提交
1585
 * using the actual heap tuple, after firing triggers if any).	In the
1586 1587 1588
 * adjusted RETURNING list, result-table Vars will still have their
 * original varno, but Vars for other rels will have varno OUTER.
 *
1589 1590
 * We also must perform opcode lookup and add regclass OIDs to
 * glob->relationOids.
1591 1592
 *
 * 'rlist': the RETURNING targetlist to be fixed
1593 1594
 * 'topplan': the top subplan node that will be just below the ModifyTable
 *		node (note it's not yet passed through set_plan_references)
1595 1596 1597 1598
 * 'resultRelation': RT index of the associated result relation
 *
 * Note: we assume that result relations will have rtoffset zero, that is,
 * they are not coming from a subplan.
1599 1600
 */
List *
1601
set_returning_clause_references(PlannerGlobal *glob,
1602
								List *rlist,
1603 1604 1605 1606 1607 1608
								Plan *topplan,
								Index resultRelation)
{
	indexed_tlist *itlist;

	/*
1609
	 * We can perform the desired Var fixup by abusing the fix_join_expr
1610
	 * machinery that formerly handled inner indexscan fixup.  We search the
B
Bruce Momjian 已提交
1611
	 * top plan's targetlist for Vars of non-result relations, and use
B
Bruce Momjian 已提交
1612 1613
	 * fix_join_expr to convert RETURNING Vars into references to those tlist
	 * entries, while leaving result-rel Vars as-is.
1614 1615
	 *
	 * PlaceHolderVars will also be sought in the targetlist, but no
1616 1617 1618 1619 1620
	 * more-complex expressions will be.  Note that it is not possible for a
	 * PlaceHolderVar to refer to the result relation, since the result is
	 * never below an outer join.  If that case could happen, we'd have to be
	 * prepared to pick apart the PlaceHolderVar and evaluate its contained
	 * expression instead.
1621 1622 1623
	 */
	itlist = build_tlist_index_other_vars(topplan->targetlist, resultRelation);

1624 1625
	rlist = fix_join_expr(glob,
						  rlist,
1626 1627 1628 1629
						  itlist,
						  NULL,
						  resultRelation,
						  0);
1630 1631 1632 1633 1634 1635

	pfree(itlist);

	return rlist;
}

1636
/*****************************************************************************
1637
 *					OPERATOR REGPROC LOOKUP
1638 1639
 *****************************************************************************/

1640
/*
1641 1642
 * fix_opfuncids
 *	  Calculate opfuncid field from opno for each OpExpr node in given tree.
1643
 *	  The given tree can be anything expression_tree_walker handles.
1644
 *
1645 1646 1647
 * The argument is modified in-place.  (This is OK since we'd want the
 * same change for any node, even if it gets visited more than once due to
 * shared structure.)
1648
 */
1649
void
1650
fix_opfuncids(Node *node)
1651
{
1652
	/* This tree walk requires no special setup, so away we go... */
1653
	fix_opfuncids_walker(node, NULL);
1654
}
B
Bruce Momjian 已提交
1655

1656
static bool
1657
fix_opfuncids_walker(Node *node, void *context)
1658 1659 1660
{
	if (node == NULL)
		return false;
1661 1662 1663
	if (IsA(node, OpExpr))
		set_opfuncid((OpExpr *) node);
	else if (IsA(node, DistinctExpr))
B
Bruce Momjian 已提交
1664
		set_opfuncid((OpExpr *) node);	/* rely on struct equivalence */
1665
	else if (IsA(node, NullIfExpr))
B
Bruce Momjian 已提交
1666
		set_opfuncid((OpExpr *) node);	/* rely on struct equivalence */
1667 1668
	else if (IsA(node, ScalarArrayOpExpr))
		set_sa_opfuncid((ScalarArrayOpExpr *) node);
1669
	return expression_tree_walker(node, fix_opfuncids_walker, context);
1670
}
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680

/*
 * set_opfuncid
 *		Set the opfuncid (procedure OID) in an OpExpr node,
 *		if it hasn't been set already.
 *
 * Because of struct equivalence, this can also be used for
 * DistinctExpr and NullIfExpr nodes.
 */
void
1681
set_opfuncid(OpExpr *opexpr)
1682 1683 1684 1685 1686 1687 1688 1689 1690
{
	if (opexpr->opfuncid == InvalidOid)
		opexpr->opfuncid = get_opcode(opexpr->opno);
}

/*
 * set_sa_opfuncid
 *		As above, for ScalarArrayOpExpr nodes.
 */
1691
void
1692
set_sa_opfuncid(ScalarArrayOpExpr *opexpr)
1693 1694 1695 1696
{
	if (opexpr->opfuncid == InvalidOid)
		opexpr->opfuncid = get_opcode(opexpr->opno);
}
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716

/*****************************************************************************
 *					QUERY DEPENDENCY MANAGEMENT
 *****************************************************************************/

/*
 * record_plan_function_dependency
 *		Mark the current plan as depending on a particular function.
 *
 * This is exported so that the function-inlining code can record a
 * dependency on a function that it's removed from the plan tree.
 */
void
record_plan_function_dependency(PlannerGlobal *glob, Oid funcid)
{
	/*
	 * For performance reasons, we don't bother to track built-in functions;
	 * we just assume they'll never change (or at least not in ways that'd
	 * invalidate plans using them).  For this purpose we can consider a
	 * built-in function to be one with OID less than FirstBootstrapObjectId.
1717 1718
	 * Note that the OID generator guarantees never to generate such an OID
	 * after startup, even at OID wraparound.
1719 1720 1721 1722 1723 1724
	 */
	if (funcid >= (Oid) FirstBootstrapObjectId)
	{
		HeapTuple	func_tuple;
		PlanInvalItem *inval_item;

1725
		func_tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcid));
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
		if (!HeapTupleIsValid(func_tuple))
			elog(ERROR, "cache lookup failed for function %u", funcid);

		inval_item = makeNode(PlanInvalItem);

		/*
		 * It would work to use any syscache on pg_proc, but plancache.c
		 * expects us to use PROCOID.
		 */
		inval_item->cacheId = PROCOID;
		inval_item->tupleId = func_tuple->t_self;

		glob->invalItems = lappend(glob->invalItems, inval_item);

		ReleaseSysCache(func_tuple);
	}
}

/*
 * extract_query_dependencies
1746 1747 1748
 *		Given a not-yet-planned query or queries (i.e. a Query node or list
 *		of Query nodes), extract dependencies just as set_plan_references
 *		would do.
1749 1750 1751 1752 1753
 *
 * This is needed by plancache.c to handle invalidation of cached unplanned
 * queries.
 */
void
1754
extract_query_dependencies(Node *query,
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
						   List **relationOids,
						   List **invalItems)
{
	PlannerGlobal glob;

	/* Make up a dummy PlannerGlobal so we can use this module's machinery */
	MemSet(&glob, 0, sizeof(glob));
	glob.type = T_PlannerGlobal;
	glob.relationOids = NIL;
	glob.invalItems = NIL;

1766
	(void) extract_query_dependencies_walker(query, &glob);
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776

	*relationOids = glob.relationOids;
	*invalItems = glob.invalItems;
}

static bool
extract_query_dependencies_walker(Node *node, PlannerGlobal *context)
{
	if (node == NULL)
		return false;
1777
	Assert(!IsA(node, PlaceHolderVar));
1778 1779 1780 1781 1782 1783 1784
	/* Extract function dependencies and check for regclass Consts */
	fix_expr_common(context, node);
	if (IsA(node, Query))
	{
		Query	   *query = (Query *) node;
		ListCell   *lc;

1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
		if (query->commandType == CMD_UTILITY)
		{
			/* Ignore utility statements, except EXPLAIN */
			if (IsA(query->utilityStmt, ExplainStmt))
			{
				query = (Query *) ((ExplainStmt *) query->utilityStmt)->query;
				Assert(IsA(query, Query));
				Assert(query->commandType != CMD_UTILITY);
			}
			else
				return false;
		}

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
		/* Collect relation OIDs in this Query's rtable */
		foreach(lc, query->rtable)
		{
			RangeTblEntry *rte = (RangeTblEntry *) lfirst(lc);

			if (rte->rtekind == RTE_RELATION)
				context->relationOids = lappend_oid(context->relationOids,
													rte->relid);
		}

		/* And recurse into the query's subexpressions */
		return query_tree_walker(query, extract_query_dependencies_walker,
								 (void *) context, 0);
	}
	return expression_tree_walker(node, extract_query_dependencies_walker,
								  (void *) context);
}