rewriteHandler.c 34.4 KB
Newer Older
1 2
/*-------------------------------------------------------------------------
 *
3
 * rewriteHandler.c
4
 *		Primary module of query rewriter.
5
 *
B
Bruce Momjian 已提交
6
 * Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
B
Add:  
Bruce Momjian 已提交
7
 * Portions Copyright (c) 1994, Regents of the University of California
8 9
 *
 * IDENTIFICATION
10
 *	  $Header: /cvsroot/pgsql/src/backend/rewrite/rewriteHandler.c,v 1.117 2003/02/13 21:39:50 tgl Exp $
11 12 13 14 15
 *
 *-------------------------------------------------------------------------
 */
#include "postgres.h"

B
Bruce Momjian 已提交
16
#include "access/heapam.h"
17
#include "catalog/pg_operator.h"
18
#include "catalog/pg_type.h"
B
Bruce Momjian 已提交
19
#include "miscadmin.h"
20
#include "nodes/makefuncs.h"
B
Bruce Momjian 已提交
21 22
#include "optimizer/clauses.h"
#include "optimizer/prep.h"
23
#include "optimizer/var.h"
B
Bruce Momjian 已提交
24
#include "parser/analyze.h"
25
#include "parser/parse_coerce.h"
26 27
#include "parser/parse_expr.h"
#include "parser/parse_oper.h"
B
Bruce Momjian 已提交
28
#include "parser/parse_type.h"
29
#include "parser/parsetree.h"
30
#include "rewrite/rewriteHandler.h"
B
Bruce Momjian 已提交
31
#include "rewrite/rewriteManip.h"
32
#include "utils/builtins.h"
B
Bruce Momjian 已提交
33
#include "utils/lsyscache.h"
34 35


36
static Query *rewriteRuleAction(Query *parsetree,
37 38 39 40
				  Query *rule_action,
				  Node *rule_qual,
				  int rt_index,
				  CmdType event);
41
static List *adjustJoinTreeList(Query *parsetree, bool removert, int rt_index);
42 43
static void rewriteTargetList(Query *parsetree, Relation target_relation);
static TargetEntry *process_matched_tle(TargetEntry *src_tle,
B
Bruce Momjian 已提交
44
					TargetEntry *prior_tle);
45
static void markQueryForUpdate(Query *qry, bool skipOldNew);
46
static List *matchLocks(CmdType event, RuleLock *rulelocks,
B
Bruce Momjian 已提交
47
		   int varno, Query *parsetree);
48
static Query *fireRIRrules(Query *parsetree);
49

50 51

/*
52 53 54
 * rewriteRuleAction -
 *	  Rewrite the rule action with appropriate qualifiers (taken from
 *	  the triggering query).
55
 */
56 57
static Query *
rewriteRuleAction(Query *parsetree,
58 59
				  Query *rule_action,
				  Node *rule_qual,
60
				  int rt_index,
61
				  CmdType event)
62
{
63 64
	int			current_varno,
				new_varno;
65
	List	   *main_rtable;
66
	int			rt_length;
67 68
	Query	   *sub_action;
	Query	  **sub_action_ptr;
69
	List	   *rt;
70

71 72 73 74 75 76 77 78
	/*
	 * Make modifiable copies of rule action and qual (what we're passed
	 * are the stored versions in the relcache; don't touch 'em!).
	 */
	rule_action = (Query *) copyObject(rule_action);
	rule_qual = (Node *) copyObject(rule_qual);

	current_varno = rt_index;
79
	rt_length = length(parsetree->rtable);
80
	new_varno = PRS2_NEW_VARNO + rt_length;
81

82 83
	/*
	 * Adjust rule action and qual to offset its varnos, so that we can
84
	 * merge its rtable with the main parsetree's rtable.
85
	 *
B
Bruce Momjian 已提交
86 87 88
	 * If the rule action is an INSERT...SELECT, the OLD/NEW rtable entries
	 * will be in the SELECT part, and we have to modify that rather than
	 * the top-level INSERT (kluge!).
89
	 */
90
	sub_action = getInsertSelectQuery(rule_action, &sub_action_ptr);
91

92
	OffsetVarNodes((Node *) sub_action, rt_length, 0);
93
	OffsetVarNodes(rule_qual, rt_length, 0);
94 95 96
	/* but references to *OLD* should point at original rt_index */
	ChangeVarNodes((Node *) sub_action,
				   PRS2_OLD_VARNO + rt_length, rt_index, 0);
97
	ChangeVarNodes(rule_qual,
98 99 100
				   PRS2_OLD_VARNO + rt_length, rt_index, 0);

	/*
101 102 103
	 * Generate expanded rtable consisting of main parsetree's rtable plus
	 * rule action's rtable; this becomes the complete rtable for the rule
	 * action.	Some of the entries may be unused after we finish
104
	 * rewriting, but if we tried to remove them we'd have a much
105 106
	 * harder job to adjust RT indexes in the query's Vars.  It's OK to
	 * have unused RT entries, since planner will ignore them.
107
	 *
108
	 * NOTE: because planner will destructively alter rtable, we must ensure
109 110
	 * that rule action's rtable is separate and shares no substructure
	 * with the main rtable.  Hence do a deep copy here.
111 112 113 114 115 116 117
	 *
	 * Also, we must disable write-access checking in all the RT entries
	 * copied from the main query.  This is safe since in fact the rule action
	 * won't write on them, and it's necessary because the rule action may
	 * have a different commandType than the main query, causing
	 * ExecCheckRTEPerms() to make an inappropriate check.  The read-access
	 * checks can be left enabled, although they're probably redundant.
118
	 */
119 120 121 122 123 124 125 126 127 128
	main_rtable = (List *) copyObject(parsetree->rtable);

	foreach(rt, main_rtable)
	{
		RangeTblEntry *rte = (RangeTblEntry *) lfirst(rt);

		rte->checkForWrite = false;
	}

	sub_action->rtable = nconc(main_rtable, sub_action->rtable);
129

130 131
	/*
	 * Each rule action's jointree should be the main parsetree's jointree
B
Bruce Momjian 已提交
132 133 134 135 136 137 138 139 140
	 * plus that rule's jointree, but usually *without* the original
	 * rtindex that we're replacing (if present, which it won't be for
	 * INSERT). Note that if the rule action refers to OLD, its jointree
	 * will add a reference to rt_index.  If the rule action doesn't refer
	 * to OLD, but either the rule_qual or the user query quals do, then
	 * we need to keep the original rtindex in the jointree to provide
	 * data for the quals.	We don't want the original rtindex to be
	 * joined twice, however, so avoid keeping it if the rule action
	 * mentions it.
141
	 *
142 143
	 * As above, the action's jointree must not share substructure with the
	 * main parsetree's.
144
	 */
145
	if (sub_action->jointree != NULL)
146
	{
B
Bruce Momjian 已提交
147 148
		bool		keeporig;
		List	   *newjointree;
149

B
Bruce Momjian 已提交
150 151
		keeporig = (!rangeTableEntry_used((Node *) sub_action->jointree,
										  rt_index, 0)) &&
152
			(rangeTableEntry_used(rule_qual, rt_index, 0) ||
153
		  rangeTableEntry_used(parsetree->jointree->quals, rt_index, 0));
154
		newjointree = adjustJoinTreeList(parsetree, !keeporig, rt_index);
155 156 157 158 159 160 161 162
		sub_action->jointree->fromlist =
			nconc(newjointree, sub_action->jointree->fromlist);
	}

	/*
	 * We copy the qualifications of the parsetree to the action and vice
	 * versa. So force hasSubLinks if one of them has it. If this is not
	 * right, the flag will get cleared later, but we mustn't risk having
163 164
	 * it not set when it needs to be.	(XXX this should probably be
	 * handled by AddQual and friends, not here...)
165 166 167 168 169 170 171
	 */
	if (parsetree->hasSubLinks)
		sub_action->hasSubLinks = TRUE;
	else if (sub_action->hasSubLinks)
		parsetree->hasSubLinks = TRUE;

	/*
B
Bruce Momjian 已提交
172 173 174
	 * Event Qualification forces copying of parsetree and splitting into
	 * two queries one w/rule_qual, one w/NOT rule_qual. Also add user
	 * query qual onto rule action
175
	 */
176
	AddQual(sub_action, rule_qual);
177 178 179 180

	AddQual(sub_action, parsetree->jointree->quals);

	/*
B
Bruce Momjian 已提交
181 182
	 * Rewrite new.attribute w/ right hand side of target-list entry for
	 * appropriate field name in insert/update.
183 184 185
	 *
	 * KLUGE ALERT: since ResolveNew returns a mutated copy, we can't just
	 * apply it to sub_action; we have to remember to update the sublink
186
	 * inside rule_action, too.
187
	 */
188
	if (event == CMD_INSERT || event == CMD_UPDATE)
189 190
	{
		sub_action = (Query *) ResolveNew((Node *) sub_action,
191
										  new_varno,
192 193
										  0,
										  parsetree->targetList,
194 195
										  event,
										  current_varno);
196 197 198
		if (sub_action_ptr)
			*sub_action_ptr = sub_action;
		else
199
			rule_action = sub_action;
200
	}
201

202
	return rule_action;
203 204
}

205
/*
206 207 208 209
 * Copy the query's jointree list, and optionally attempt to remove any
 * occurrence of the given rt_index as a top-level join item (we do not look
 * for it within join items; this is OK because we are only expecting to find
 * it as an UPDATE or DELETE target relation, which will be at the top level
210 211
 * of the join).  Returns modified jointree list --- this is a separate copy
 * sharing no nodes with the original.
212
 */
213
static List *
214
adjustJoinTreeList(Query *parsetree, bool removert, int rt_index)
215
{
216
	List	   *newjointree = copyObject(parsetree->jointree->fromlist);
217
	List	   *jjt;
218

219
	if (removert)
B
Bruce Momjian 已提交
220
	{
221
		foreach(jjt, newjointree)
222
		{
223 224
			RangeTblRef *rtr = lfirst(jjt);

225 226
			if (IsA(rtr, RangeTblRef) &&
				rtr->rtindex == rt_index)
227 228
			{
				newjointree = lremove(rtr, newjointree);
229
				/* foreach is safe because we exit loop after lremove... */
230 231
				break;
			}
232
		}
233
	}
234
	return newjointree;
235
}
236

237

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
/*
 * rewriteTargetList - rewrite INSERT/UPDATE targetlist into standard form
 *
 * This has the following responsibilities:
 *
 * 1. For an INSERT, add tlist entries to compute default values for any
 * attributes that have defaults and are not assigned to in the given tlist.
 * (We do not insert anything for default-less attributes, however.  The
 * planner will later insert NULLs for them, but there's no reason to slow
 * down rewriter processing with extra tlist nodes.)
 *
 * 2. Merge multiple entries for the same target attribute, or declare error
 * if we can't.  Presently, multiple entries are only allowed for UPDATE of
 * an array field, for example "UPDATE table SET foo[2] = 42, foo[4] = 43".
 * We can merge such operations into a single assignment op.  Essentially,
 * the expression we want to produce in this case is like
 *		foo = array_set(array_set(foo, 2, 42), 4, 43)
 *
 * 3. Sort the tlist into standard order: non-junk fields in order by resno,
 * then junk fields (these in no particular order).
 *
 * We must do items 1 and 2 before firing rewrite rules, else rewritten
B
Bruce Momjian 已提交
260
 * references to NEW.foo will produce wrong or incomplete results.	Item 3
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
 * is not needed for rewriting, but will be needed by the planner, and we
 * can do it essentially for free while handling items 1 and 2.
 */
static void
rewriteTargetList(Query *parsetree, Relation target_relation)
{
	CmdType		commandType = parsetree->commandType;
	List	   *tlist = parsetree->targetList;
	List	   *new_tlist = NIL;
	int			attrno,
				numattrs;
	List	   *temp;

	/*
	 * Scan the tuple description in the relation's relcache entry to make
	 * sure we have all the user attributes in the right order.
	 */
	numattrs = RelationGetNumberOfAttributes(target_relation);

	for (attrno = 1; attrno <= numattrs; attrno++)
	{
B
Bruce Momjian 已提交
282
		Form_pg_attribute att_tup = target_relation->rd_att->attrs[attrno - 1];
283 284
		TargetEntry *new_tle = NULL;

285 286 287 288
		/* We can ignore deleted attributes */
		if (att_tup->attisdropped)
			continue;

289
		/*
B
Bruce Momjian 已提交
290
		 * Look for targetlist entries matching this attr.	We match by
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
		 * resno, but the resname should match too.
		 *
		 * Junk attributes are not candidates to be matched.
		 */
		foreach(temp, tlist)
		{
			TargetEntry *old_tle = (TargetEntry *) lfirst(temp);
			Resdom	   *resdom = old_tle->resdom;

			if (!resdom->resjunk && resdom->resno == attrno)
			{
				Assert(strcmp(resdom->resname,
							  NameStr(att_tup->attname)) == 0);
				new_tle = process_matched_tle(old_tle, new_tle);
				/* keep scanning to detect multiple assignments to attr */
			}
		}

		if (new_tle == NULL && commandType == CMD_INSERT)
		{
			/*
B
Bruce Momjian 已提交
312 313 314
			 * Didn't find a matching tlist entry; if it's an INSERT, look
			 * for a default value, and add a tlist entry computing the
			 * default if we find one.
315 316 317 318 319 320 321 322 323
			 */
			Node	   *new_expr;

			new_expr = build_column_default(target_relation, attrno);

			if (new_expr)
				new_tle = makeTargetEntry(makeResdom(attrno,
													 att_tup->atttypid,
													 att_tup->atttypmod,
B
Bruce Momjian 已提交
324
									  pstrdup(NameStr(att_tup->attname)),
325
													 false),
326
										  (Expr *) new_expr);
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
		}

		if (new_tle)
			new_tlist = lappend(new_tlist, new_tle);
	}

	/*
	 * Copy all resjunk tlist entries to the end of the new tlist, and
	 * assign them resnos above the last real resno.
	 *
	 * Typical junk entries include ORDER BY or GROUP BY expressions (are
	 * these actually possible in an INSERT or UPDATE?), system attribute
	 * references, etc.
	 */
	foreach(temp, tlist)
	{
		TargetEntry *old_tle = (TargetEntry *) lfirst(temp);
		Resdom	   *resdom = old_tle->resdom;

		if (resdom->resjunk)
		{
			/* Get the resno right, but don't copy unnecessarily */
			if (resdom->resno != attrno)
			{
				resdom = (Resdom *) copyObject((Node *) resdom);
				resdom->resno = attrno;
				old_tle = makeTargetEntry(resdom, old_tle->expr);
			}
			new_tlist = lappend(new_tlist, old_tle);
			attrno++;
		}
		else
		{
			/* Let's just make sure we processed all the non-junk items */
			if (resdom->resno < 1 || resdom->resno > numattrs)
				elog(ERROR, "rewriteTargetList: bogus resno %d in targetlist",
					 resdom->resno);
		}
	}

	parsetree->targetList = new_tlist;
}


/*
 * Convert a matched TLE from the original tlist into a correct new TLE.
 *
 * This routine detects and handles multiple assignments to the same target
 * attribute.
 */
static TargetEntry *
process_matched_tle(TargetEntry *src_tle,
					TargetEntry *prior_tle)
{
	Resdom	   *resdom = src_tle->resdom;
	Node	   *priorbottom;
	ArrayRef   *newexpr;

	if (prior_tle == NULL)
	{
		/*
		 * Normal case where this is the first assignment to the
		 * attribute.
		 */
		return src_tle;
	}

	/*
	 * Multiple assignments to same attribute.	Allow only if all are
	 * array-assign operators with same bottom array object.
	 */
	if (src_tle->expr == NULL || !IsA(src_tle->expr, ArrayRef) ||
		((ArrayRef *) src_tle->expr)->refassgnexpr == NULL ||
		prior_tle->expr == NULL || !IsA(prior_tle->expr, ArrayRef) ||
		((ArrayRef *) prior_tle->expr)->refassgnexpr == NULL ||
402 403
		((ArrayRef *) src_tle->expr)->refrestype !=
		((ArrayRef *) prior_tle->expr)->refrestype)
404 405 406 407 408 409 410
		elog(ERROR, "Multiple assignments to same attribute \"%s\"",
			 resdom->resname);

	/*
	 * Prior TLE could be a nest of ArrayRefs if we do this more than
	 * once.
	 */
411
	priorbottom = (Node *) ((ArrayRef *) prior_tle->expr)->refexpr;
412 413
	while (priorbottom != NULL && IsA(priorbottom, ArrayRef) &&
		   ((ArrayRef *) priorbottom)->refassgnexpr != NULL)
414
		priorbottom = (Node *) ((ArrayRef *) priorbottom)->refexpr;
415 416 417 418 419 420 421 422 423 424 425
	if (!equal(priorbottom, ((ArrayRef *) src_tle->expr)->refexpr))
		elog(ERROR, "Multiple assignments to same attribute \"%s\"",
			 resdom->resname);

	/*
	 * Looks OK to nest 'em.
	 */
	newexpr = makeNode(ArrayRef);
	memcpy(newexpr, src_tle->expr, sizeof(ArrayRef));
	newexpr->refexpr = prior_tle->expr;

426
	return makeTargetEntry(resdom, (Expr *) newexpr);
427 428 429 430 431 432 433 434
}


/*
 * Make an expression tree for the default value for a column.
 *
 * If there is no default, return a NULL instead.
 */
435
Node *
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
build_column_default(Relation rel, int attrno)
{
	TupleDesc	rd_att = rel->rd_att;
	Form_pg_attribute att_tup = rd_att->attrs[attrno - 1];
	Oid			atttype = att_tup->atttypid;
	int32		atttypmod = att_tup->atttypmod;
	Node	   *expr = NULL;
	Oid			exprtype;

	/*
	 * Scan to see if relation has a default for this column.
	 */
	if (rd_att->constr && rd_att->constr->num_defval > 0)
	{
		AttrDefault *defval = rd_att->constr->defval;
		int			ndef = rd_att->constr->num_defval;

		while (--ndef >= 0)
		{
			if (attrno == defval[ndef].adnum)
			{
				/*
				 * Found it, convert string representation to node tree.
				 */
				expr = stringToNode(defval[ndef].adbin);
				break;
			}
		}
	}

	if (expr == NULL)
	{
		/*
B
Bruce Momjian 已提交
469 470
		 * No per-column default, so look for a default for the type
		 * itself.
471 472 473 474
		 */
		if (att_tup->attisset)
		{
			/*
B
Bruce Momjian 已提交
475 476 477
			 * Set attributes are represented as OIDs no matter what the
			 * set element type is, and the element type's default is
			 * irrelevant too.
478 479 480 481 482 483 484 485 486 487
			 */
		}
		else
			expr = get_typdefault(atttype);
	}

	if (expr == NULL)
		return NULL;			/* No default anywhere */

	/*
B
Bruce Momjian 已提交
488 489 490
	 * Make sure the value is coerced to the target column type (might not
	 * be right type yet if it's not a constant!)  This should match the
	 * parser's processing of non-defaulted expressions --- see
491 492 493 494
	 * updateTargetListEntry().
	 */
	exprtype = exprType(expr);

495 496 497 498
	expr = coerce_to_target_type(expr, exprtype,
								 atttype, atttypmod,
								 COERCION_ASSIGNMENT,
								 COERCE_IMPLICIT_CAST);
499
	/*
500 501
	 * This really shouldn't fail; should have checked the default's
	 * type when it was created ...
502
	 */
503 504 505 506 507 508 509
	if (expr == NULL)
		elog(ERROR, "Column \"%s\" is of type %s"
			 " but default expression is of type %s"
			 "\n\tYou will need to rewrite or cast the expression",
			 NameStr(att_tup->attname),
			 format_type_be(atttype),
			 format_type_be(exprtype));
510 511 512 513 514

	return expr;
}


515
/*
516 517
 * matchLocks -
 *	  match the list of locks and returns the matching rules
518
 */
519 520 521 522 523
static List *
matchLocks(CmdType event,
		   RuleLock *rulelocks,
		   int varno,
		   Query *parsetree)
524
{
525
	List	   *matching_locks = NIL;
526 527
	int			nlocks;
	int			i;
528

529 530
	Assert(rulelocks != NULL);	/* we get called iff there is some lock */
	Assert(parsetree != NULL);
531

532
	if (parsetree->commandType != CMD_SELECT)
533
	{
534 535
		if (parsetree->resultRelation != varno)
			return NIL;
536
	}
537

538
	nlocks = rulelocks->numLocks;
539

540
	for (i = 0; i < nlocks; i++)
B
Bruce Momjian 已提交
541
	{
542
		RewriteRule *oneLock = rulelocks->rules[i];
543

544
		if (oneLock->event == event)
545
		{
546 547 548 549 550
			if (parsetree->commandType != CMD_SELECT ||
				(oneLock->attrno == -1 ?
				 rangeTableEntry_used((Node *) parsetree, varno, 0) :
				 attribute_used((Node *) parsetree,
								varno, oneLock->attrno, 0)))
551
				matching_locks = lappend(matching_locks, oneLock);
552
		}
553
	}
554

555
	return matching_locks;
556 557
}

558

559 560 561 562 563 564 565 566 567 568 569
static Query *
ApplyRetrieveRule(Query *parsetree,
				  RewriteRule *rule,
				  int rt_index,
				  bool relation_level,
				  Relation relation,
				  bool relIsUsed)
{
	Query	   *rule_action;
	RangeTblEntry *rte,
			   *subrte;
570

571 572 573 574
	if (length(rule->actions) != 1)
		elog(ERROR, "ApplyRetrieveRule: expected just one rule action");
	if (rule->qual != NULL)
		elog(ERROR, "ApplyRetrieveRule: can't handle qualified ON SELECT rule");
B
Bruce Momjian 已提交
575
	if (!relation_level)
576
		elog(ERROR, "ApplyRetrieveRule: can't handle per-attribute ON SELECT rule");
577

578
	/*
579 580
	 * Make a modifiable copy of the view query, and recursively expand
	 * any view references inside it.
581
	 */
582
	rule_action = copyObject(lfirst(rule->actions));
583

584
	rule_action = fireRIRrules(rule_action);
585

586
	/*
B
Bruce Momjian 已提交
587 588
	 * VIEWs are really easy --- just plug the view query in as a
	 * subselect, replacing the relation's original RTE.
589
	 */
590
	rte = rt_fetch(rt_index, parsetree->rtable);
591

592
	rte->rtekind = RTE_SUBQUERY;
593 594 595
	rte->relid = InvalidOid;
	rte->subquery = rule_action;
	rte->inh = false;			/* must not be set for a subquery */
596

597
	/*
598 599
	 * We move the view's permission check data down to its rangetable.
	 * The checks will actually be done against the *OLD* entry therein.
600
	 */
601 602 603 604
	subrte = rt_fetch(PRS2_OLD_VARNO, rule_action->rtable);
	Assert(subrte->relid == relation->rd_id);
	subrte->checkForRead = rte->checkForRead;
	subrte->checkForWrite = rte->checkForWrite;
605
	subrte->checkAsUser = rte->checkAsUser;
606

607 608
	rte->checkForRead = false;	/* no permission check on subquery itself */
	rte->checkForWrite = false;
609
	rte->checkAsUser = InvalidOid;
610

611
	/*
612
	 * FOR UPDATE of view?
613
	 */
614
	if (intMember(rt_index, parsetree->rowMarks))
615
	{
616
		/*
617 618 619
		 * Remove the view from the list of rels that will actually be
		 * marked FOR UPDATE by the executor.  It will still be access-
		 * checked for write access, though.
620
		 */
621
		parsetree->rowMarks = lremovei(rt_index, parsetree->rowMarks);
B
Bruce Momjian 已提交
622 623

		/*
624
		 * Set up the view's referenced tables as if FOR UPDATE.
625
		 */
626
		markQueryForUpdate(rule_action, true);
627 628
	}

629
	return parsetree;
630 631
}

632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
/*
 * Recursively mark all relations used by a view as FOR UPDATE.
 *
 * This may generate an invalid query, eg if some sub-query uses an
 * aggregate.  We leave it to the planner to detect that.
 *
 * NB: this must agree with the parser's transformForUpdate() routine.
 */
static void
markQueryForUpdate(Query *qry, bool skipOldNew)
{
	Index		rti = 0;
	List	   *l;

	foreach(l, qry->rtable)
	{
		RangeTblEntry *rte = (RangeTblEntry *) lfirst(l);

		rti++;

		/* Ignore OLD and NEW entries if we are at top level of view */
		if (skipOldNew &&
			(rti == PRS2_OLD_VARNO || rti == PRS2_NEW_VARNO))
			continue;

657
		if (rte->rtekind == RTE_RELATION)
658 659 660 661 662
		{
			if (!intMember(rti, qry->rowMarks))
				qry->rowMarks = lappendi(qry->rowMarks, rti);
			rte->checkForWrite = true;
		}
663 664 665 666 667
		else if (rte->rtekind == RTE_SUBQUERY)
		{
			/* FOR UPDATE of subquery is propagated to subquery's rels */
			markQueryForUpdate(rte->subquery, false);
		}
668 669 670
	}
}

671

672
/*
673 674 675
 * fireRIRonSubLink -
 *	Apply fireRIRrules() to each SubLink (subselect in expression) found
 *	in the given tree.
676 677
 *
 * NOTE: although this has the form of a walker, we cheat and modify the
678
 * SubLink nodes in-place.	It is caller's responsibility to ensure that
679
 * no unwanted side-effects occur!
680 681 682 683
 *
 * This is unlike most of the other routines that recurse into subselects,
 * because we must take control at the SubLink node in order to replace
 * the SubLink's subselect link with the possibly-rewritten subquery.
684 685
 */
static bool
686
fireRIRonSubLink(Node *node, void *context)
687 688
{
	if (node == NULL)
689 690
		return false;
	if (IsA(node, SubLink))
B
Bruce Momjian 已提交
691
	{
692 693 694
		SubLink    *sub = (SubLink *) node;

		/* Do what we came for */
695 696
		sub->subselect = (Node *) fireRIRrules((Query *) (sub->subselect));
		/* Fall through to process lefthand args of SubLink */
697
	}
B
Bruce Momjian 已提交
698

699 700
	/*
	 * Do NOT recurse into Query nodes, because fireRIRrules already
701
	 * processed subselects of subselects for us.
702
	 */
703
	return expression_tree_walker(node, fireRIRonSubLink,
704
								  (void *) context);
705 706 707 708 709 710 711 712 713 714
}


/*
 * fireRIRrules -
 *	Apply all RIR rules on each rangetable entry in a query
 */
static Query *
fireRIRrules(Query *parsetree)
{
B
Bruce Momjian 已提交
715
	int			rt_index;
716

717 718 719
	/*
	 * don't try to convert this into a foreach loop, because rtable list
	 * can get changed each time through...
720
	 */
721
	rt_index = 0;
B
Bruce Momjian 已提交
722 723
	while (rt_index < length(parsetree->rtable))
	{
724 725 726 727 728 729 730 731 732 733
		RangeTblEntry *rte;
		Relation	rel;
		List	   *locks;
		RuleLock   *rules;
		RewriteRule *rule;
		LOCKMODE	lockmode;
		bool		relIsUsed;
		int			i;
		List	   *l;

734 735
		++rt_index;

736
		rte = rt_fetch(rt_index, parsetree->rtable);
737

738 739 740 741 742
		/*
		 * A subquery RTE can't have associated rules, so there's nothing
		 * to do to this level of the query, but we must recurse into the
		 * subquery to expand any rule references in it.
		 */
743
		if (rte->rtekind == RTE_SUBQUERY)
744 745 746 747 748
		{
			rte->subquery = fireRIRrules(rte->subquery);
			continue;
		}

749 750 751 752 753 754
		/*
		 * Joins and other non-relation RTEs can be ignored completely.
		 */
		if (rte->rtekind != RTE_RELATION)
			continue;

755
		/*
756 757 758
		 * If the table is not referenced in the query, then we ignore it.
		 * This prevents infinite expansion loop due to new rtable entries
		 * inserted by expansion of a rule. A table is referenced if it is
759 760
		 * part of the join set (a source table), or is referenced by any
		 * Var nodes, or is the result table.
761
		 */
762 763 764
		relIsUsed = rangeTableEntry_used((Node *) parsetree, rt_index, 0);

		if (!relIsUsed && rt_index != parsetree->resultRelation)
765
			continue;
B
Bruce Momjian 已提交
766

767
		/*
B
Bruce Momjian 已提交
768 769 770 771 772 773
		 * This may well be the first access to the relation during the
		 * current statement (it will be, if this Query was extracted from
		 * a rule or somehow got here other than via the parser).
		 * Therefore, grab the appropriate lock type for the relation, and
		 * do not release it until end of transaction.	This protects the
		 * rewriter and planner against schema changes mid-query.
774
		 *
B
Bruce Momjian 已提交
775 776 777 778
		 * If the relation is the query's result relation, then
		 * RewriteQuery() already got the right lock on it, so we need no
		 * additional lock. Otherwise, check to see if the relation is
		 * accessed FOR UPDATE or not.
779 780 781 782 783 784 785 786
		 */
		if (rt_index == parsetree->resultRelation)
			lockmode = NoLock;
		else if (intMember(rt_index, parsetree->rowMarks))
			lockmode = RowShareLock;
		else
			lockmode = AccessShareLock;

787
		rel = heap_open(rte->relid, lockmode);
788 789 790 791

		/*
		 * Collect the RIR rules that we must apply
		 */
792 793
		rules = rel->rd_rules;
		if (rules == NULL)
B
Bruce Momjian 已提交
794
		{
795
			heap_close(rel, NoLock);
796 797
			continue;
		}
798
		locks = NIL;
B
Bruce Momjian 已提交
799 800
		for (i = 0; i < rules->numLocks; i++)
		{
801 802 803
			rule = rules->rules[i];
			if (rule->event != CMD_SELECT)
				continue;
B
Bruce Momjian 已提交
804

805 806 807
			if (rule->attrno > 0)
			{
				/* per-attr rule; do we need it? */
808
				if (!attribute_used((Node *) parsetree, rt_index,
809
									rule->attrno, 0))
810 811
					continue;
			}
812 813 814 815 816 817 818

			locks = lappend(locks, rule);
		}

		/*
		 * Now apply them
		 */
B
Bruce Momjian 已提交
819 820
		foreach(l, locks)
		{
821 822
			rule = lfirst(l);

823
			parsetree = ApplyRetrieveRule(parsetree,
824
										  rule,
825
										  rt_index,
826
										  rule->attrno == -1,
827
										  rel,
828
										  relIsUsed);
829 830
		}

831
		heap_close(rel, NoLock);
832 833
	}

834
	/*
835 836
	 * Recurse into sublink subqueries, too.  But we already did the ones
	 * in the rtable.
837 838
	 */
	if (parsetree->hasSubLinks)
839
		query_tree_walker(parsetree, fireRIRonSubLink, NULL,
840
						  QTW_IGNORE_RT_SUBQUERIES);
841

842
	/*
B
Bruce Momjian 已提交
843 844 845 846 847
	 * If the query was marked having aggregates, check if this is still
	 * true after rewriting.  Ditto for sublinks.  Note there should be no
	 * aggs in the qual at this point.	(Does this code still do anything
	 * useful?	The view-becomes-subselect-in-FROM approach doesn't look
	 * like it could remove aggs or sublinks...)
848 849 850 851 852 853 854 855
	 */
	if (parsetree->hasAggs)
	{
		parsetree->hasAggs = checkExprHasAggs((Node *) parsetree);
		if (parsetree->hasAggs)
			if (checkExprHasAggs((Node *) parsetree->jointree))
				elog(ERROR, "fireRIRrules: failed to remove aggs from qual");
	}
856
	if (parsetree->hasSubLinks)
857
		parsetree->hasSubLinks = checkExprHasSubLink((Node *) parsetree);
858

859 860 861 862
	return parsetree;
}


863
/*
864 865 866 867 868
 * Modify the given query by adding 'AND rule_qual IS NOT TRUE' to its
 * qualification.  This is used to generate suitable "else clauses" for
 * conditional INSTEAD rules.  (Unfortunately we must use "x IS NOT TRUE",
 * not just "NOT x" which the planner is much smarter about, else we will
 * do the wrong thing when the qual evaluates to NULL.)
869
 *
B
Bruce Momjian 已提交
870
 * The rule_qual may contain references to OLD or NEW.	OLD references are
871 872 873 874 875
 * replaced by references to the specified rt_index (the relation that the
 * rule applies to).  NEW references are only possible for INSERT and UPDATE
 * queries on the relation itself, and so they should be replaced by copies
 * of the related entries in the query's own targetlist.
 */
876
static Query *
877 878 879 880
CopyAndAddInvertedQual(Query *parsetree,
					   Node *rule_qual,
					   int rt_index,
					   CmdType event)
881
{
882
	Query	   *new_tree = (Query *) copyObject(parsetree);
883 884 885 886 887 888 889 890 891 892 893 894 895
	Node	   *new_qual = (Node *) copyObject(rule_qual);

	/* Fix references to OLD */
	ChangeVarNodes(new_qual, PRS2_OLD_VARNO, rt_index, 0);
	/* Fix references to NEW */
	if (event == CMD_INSERT || event == CMD_UPDATE)
		new_qual = ResolveNew(new_qual,
							  PRS2_NEW_VARNO,
							  0,
							  parsetree->targetList,
							  event,
							  rt_index);
	/* And attach the fixed qual */
896
	AddInvertedQual(new_tree, new_qual);
897 898

	return new_tree;
899 900 901 902
}


/*
903
 *	fireRules -
M
 
Marc G. Fournier 已提交
904
 *	   Iterate through rule locks applying rules.
905
 *
906 907 908 909 910 911 912 913 914 915 916 917
 * Input arguments:
 *	parsetree - original query
 *	rt_index - RT index of result relation in original query
 *	event - type of rule event
 *	locks - list of rules to fire
 * Output arguments:
 *	*instead_flag - set TRUE if any unqualified INSTEAD rule is found
 *					(must be initialized to FALSE)
 *	*qual_product - filled with modified original query if any qualified
 *					INSTEAD rule is found (must be initialized to NULL)
 * Return value:
 *	list of rule actions adjusted for use with this query
918
 *
919 920 921 922 923 924 925 926
 * Qualified INSTEAD rules generate their action with the qualification
 * condition added.  They also generate a modified version of the original
 * query with the negated qualification added, so that it will run only for
 * rows that the qualified action doesn't act on.  (If there are multiple
 * qualified INSTEAD rules, we AND all the negated quals onto a single
 * modified original query.)  We won't execute the original, unmodified
 * query if we find either qualified or unqualified INSTEAD rules.  If
 * we find both, the modified original query is discarded too.
927
 */
928
static List *
929
fireRules(Query *parsetree,
930 931
		  int rt_index,
		  CmdType event,
932
		  List *locks,
933 934
		  bool *instead_flag,
		  Query **qual_product)
935
{
936 937
	List	   *results = NIL;
	List	   *i;
938 939 940

	foreach(i, locks)
	{
941
		RewriteRule *rule_lock = (RewriteRule *) lfirst(i);
942 943
		Node	   *event_qual = rule_lock->qual;
		List	   *actions = rule_lock->actions;
944
		QuerySource	qsrc;
945
		List	   *r;
946

947 948 949 950 951 952
		/* Determine correct QuerySource value for actions */
		if (rule_lock->isInstead)
		{
			if (event_qual != NULL)
				qsrc = QSRC_QUAL_INSTEAD_RULE;
			else
953
			{
954
				qsrc = QSRC_INSTEAD_RULE;
955 956
				*instead_flag = true; /* report unqualified INSTEAD */
			}
957 958 959 960 961
		}
		else
			qsrc = QSRC_NON_INSTEAD_RULE;

		if (qsrc == QSRC_QUAL_INSTEAD_RULE)
962
		{
963
			/*
964
			 * If there are INSTEAD rules with qualifications, the
965
			 * original query is still performed. But all the negated rule
966
			 * qualifications of the INSTEAD rules are added so it does
967
			 * its actions only in cases where the rule quals of all
968 969
			 * INSTEAD rules are false. Think of it as the default action
			 * in a case. We save this in *qual_product so
970 971
			 * deepRewriteQuery() can add it to the query list after we
			 * mangled it up enough.
972 973 974
			 *
			 * If we have already found an unqualified INSTEAD rule,
			 * then *qual_product won't be used, so don't bother building it.
M
 
Marc G. Fournier 已提交
975
			 */
976 977 978 979
			if (! *instead_flag)
			{
				if (*qual_product == NULL)
					*qual_product = parsetree;
980 981 982 983
				*qual_product = CopyAndAddInvertedQual(*qual_product,
													   event_qual,
													   rt_index,
													   event);
984
			}
M
 
Marc G. Fournier 已提交
985 986
		}

987
		/* Now process the rule's actions and add them to the result list */
988 989
		foreach(r, actions)
		{
990
			Query	   *rule_action = lfirst(r);
991

M
 
Marc G. Fournier 已提交
992 993 994
			if (rule_action->commandType == CMD_NOTHING)
				continue;

995 996
			rule_action = rewriteRuleAction(parsetree, rule_action,
											event_qual, rt_index, event);
997

998 999
			rule_action->querySource = qsrc;

1000
			results = lappend(results, rule_action);
1001 1002
		}
	}
1003

1004
	return results;
1005 1006
}

M
 
Marc G. Fournier 已提交
1007

1008 1009 1010 1011 1012 1013
/*
 * One pass of rewriting a single query.
 *
 * parsetree is the input query.  Return value and output parameters
 * are defined the same as for fireRules, above.
 */
1014
static List *
1015
RewriteQuery(Query *parsetree, bool *instead_flag, Query **qual_product)
1016
{
1017
	CmdType		event;
B
Bruce Momjian 已提交
1018
	List	   *product_queries = NIL;
1019
	int			result_relation;
B
Bruce Momjian 已提交
1020
	RangeTblEntry *rt_entry;
1021 1022
	Relation	rt_entry_relation;
	RuleLock   *rt_entry_locks;
1023

1024 1025 1026 1027
	Assert(parsetree != NULL);

	event = parsetree->commandType;

1028
	/*
B
Bruce Momjian 已提交
1029 1030
	 * SELECT rules are handled later when we have all the queries that
	 * should get executed
1031 1032 1033 1034 1035 1036 1037
	 */
	if (event == CMD_SELECT)
		return NIL;

	/*
	 * Utilities aren't rewritten at all - why is this here?
	 */
1038 1039
	if (event == CMD_UTILITY)
		return NIL;
1040

1041
	/*
B
Bruce Momjian 已提交
1042
	 * the statement is an update, insert or delete - fire rules on it.
1043
	 */
1044
	result_relation = parsetree->resultRelation;
1045
	Assert(result_relation != 0);
1046
	rt_entry = rt_fetch(result_relation, parsetree->rtable);
1047
	Assert(rt_entry->rtekind == RTE_RELATION);
1048 1049

	/*
B
Bruce Momjian 已提交
1050 1051 1052 1053 1054 1055
	 * This may well be the first access to the result relation during the
	 * current statement (it will be, if this Query was extracted from a
	 * rule or somehow got here other than via the parser). Therefore,
	 * grab the appropriate lock type for a result relation, and do not
	 * release it until end of transaction.  This protects the rewriter
	 * and planner against schema changes mid-query.
1056
	 */
1057
	rt_entry_relation = heap_open(rt_entry->relid, RowExclusiveLock);
1058

1059 1060 1061 1062 1063 1064 1065 1066
	/*
	 * If it's an INSERT or UPDATE, rewrite the targetlist into standard
	 * form.  This will be needed by the planner anyway, and doing it now
	 * ensures that any references to NEW.field will behave sanely.
	 */
	if (event == CMD_INSERT || event == CMD_UPDATE)
		rewriteTargetList(parsetree, rt_entry_relation);

1067 1068 1069
	/*
	 * Collect and apply the appropriate rules.
	 */
1070
	rt_entry_locks = rt_entry_relation->rd_rules;
M
 
Marc G. Fournier 已提交
1071

1072
	if (rt_entry_locks != NULL)
1073
	{
1074 1075
		List	   *locks = matchLocks(event, rt_entry_locks,
									   result_relation, parsetree);
1076

1077
		product_queries = fireRules(parsetree,
B
Bruce Momjian 已提交
1078 1079 1080
									result_relation,
									event,
									locks,
1081 1082
									instead_flag,
									qual_product);
1083
	}
1084

B
Bruce Momjian 已提交
1085
	heap_close(rt_entry_relation, NoLock);		/* keep lock! */
1086

1087
	return product_queries;
1088 1089
}

1090

1091 1092
/*
 * to avoid infinite recursion, we restrict the number of times a query
1093
 * can be rewritten. Detecting cycles is left for the reader as an exercise.
1094 1095
 */
#ifndef REWRITE_INVOKE_MAX
1096
#define REWRITE_INVOKE_MAX		100
1097 1098
#endif

1099
static int	numQueryRewriteInvoked = 0;
1100 1101 1102

/*
 * deepRewriteQuery -
1103
 *	  rewrites the query and apply the rules again on the queries rewritten
1104
 */
1105
static List *
1106
deepRewriteQuery(Query *parsetree)
1107
{
1108
	List	   *rewritten = NIL;
1109
	List	   *result;
1110 1111 1112
	bool		instead = false;
	Query	   *qual_product = NULL;
	List	   *n;
1113 1114

	if (++numQueryRewriteInvoked > REWRITE_INVOKE_MAX)
1115
		elog(ERROR, "query rewritten %d times, may contain cycles",
1116 1117
			 numQueryRewriteInvoked - 1);

1118
	result = RewriteQuery(parsetree, &instead, &qual_product);
1119

1120 1121
	foreach(n, result)
	{
1122
		Query	   *pt = lfirst(n);
1123
		List	   *newstuff;
1124 1125

		newstuff = deepRewriteQuery(pt);
1126
		rewritten = nconc(rewritten, newstuff);
1127
	}
M
 
Marc G. Fournier 已提交
1128

1129
	/*
1130 1131 1132 1133
	 * For INSERTs, the original query is done first; for UPDATE/DELETE,
	 * it is done last.  This is needed because update and delete rule
	 * actions might not do anything if they are invoked after the update
	 * or delete is performed. The command counter increment between the
1134
	 * query executions makes the deleted (and maybe the updated) tuples
1135 1136
	 * disappear so the scans for them in the rule actions cannot find
	 * them.
1137 1138 1139 1140
	 *
	 * If we found any unqualified INSTEAD, the original query is not
	 * done at all, in any form.  Otherwise, we add the modified form
	 * if qualified INSTEADs were found, else the unmodified form.
M
 
Marc G. Fournier 已提交
1141
	 */
1142
	if (!instead)
1143
	{
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
		if (parsetree->commandType == CMD_INSERT)
		{
			if (qual_product != NULL)
				rewritten = lcons(qual_product, rewritten);
			else
				rewritten = lcons(parsetree, rewritten);
		}
		else
		{
			if (qual_product != NULL)
				rewritten = lappend(rewritten, qual_product);
			else
				rewritten = lappend(rewritten, parsetree);
		}
1158
	}
M
 
Marc G. Fournier 已提交
1159

1160 1161
	return rewritten;
}
1162 1163 1164


/*
1165
 * QueryRewriteOne -
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
 *	  rewrite one query
 */
static List *
QueryRewriteOne(Query *parsetree)
{
	numQueryRewriteInvoked = 0;

	/*
	 * take a deep breath and apply all the rewrite rules - ay
	 */
	return deepRewriteQuery(parsetree);
}


/*
1181 1182 1183 1184 1185 1186 1187
 * QueryRewrite -
 *	  Primary entry point to the query rewriter.
 *	  Rewrite one query via query rewrite system, possibly returning 0
 *	  or many queries.
 *
 * NOTE: The code in QueryRewrite was formerly in pg_parse_and_plan(), and was
 * moved here so that it would be invoked during EXPLAIN.
1188
 */
1189 1190
List *
QueryRewrite(Query *parsetree)
1191
{
B
Bruce Momjian 已提交
1192 1193 1194
	List	   *querylist;
	List	   *results = NIL;
	List	   *l;
1195 1196 1197 1198 1199 1200 1201 1202 1203

	/*
	 * Step 1
	 *
	 * Apply all non-SELECT rules possibly getting 0 or many queries
	 */
	querylist = QueryRewriteOne(parsetree);

	/*
1204
	 * Step 2
1205 1206 1207
	 *
	 * Apply all the RIR rules on each query
	 */
B
Bruce Momjian 已提交
1208 1209
	foreach(l, querylist)
	{
B
Bruce Momjian 已提交
1210
		Query	   *query = (Query *) lfirst(l);
B
Bruce Momjian 已提交
1211

1212
		query = fireRIRrules(query);
1213

B
Bruce Momjian 已提交
1214
		/*
1215
		 * If the query target was rewritten as a view, complain.
B
Bruce Momjian 已提交
1216
		 */
1217
		if (query->resultRelation)
B
Bruce Momjian 已提交
1218
		{
1219 1220
			RangeTblEntry *rte = rt_fetch(query->resultRelation,
										  query->rtable);
B
Bruce Momjian 已提交
1221

1222
			if (rte->rtekind == RTE_SUBQUERY)
B
Bruce Momjian 已提交
1223
			{
1224 1225 1226
				switch (query->commandType)
				{
					case CMD_INSERT:
1227 1228
						elog(ERROR, "Cannot insert into a view"
							 "\n\tYou need an unconditional ON INSERT DO INSTEAD rule");
1229 1230
						break;
					case CMD_UPDATE:
1231 1232
						elog(ERROR, "Cannot update a view"
							 "\n\tYou need an unconditional ON UPDATE DO INSTEAD rule");
1233 1234
						break;
					case CMD_DELETE:
1235 1236
						elog(ERROR, "Cannot delete from a view"
							 "\n\tYou need an unconditional ON DELETE DO INSTEAD rule");
1237 1238 1239 1240 1241 1242
						break;
					default:
						elog(ERROR, "QueryRewrite: unexpected commandType %d",
							 (int) query->commandType);
						break;
				}
B
Bruce Momjian 已提交
1243 1244 1245
			}
		}

1246
		results = lappend(results, query);
B
Bruce Momjian 已提交
1247
	}
1248

1249
	return results;
B
Hi!  
Bruce Momjian 已提交
1250
}