Explicitly support the case that a plancache's raw_parse_tree is NULL.

tglsfdc · tglsfdc · commit d47fff3d72cd · 2014-11-12T15:58:47.000-05:00
This only happens if a client issues a Parse message with an empty query string, which is a bit odd; but since it is explicitly called out as legal by our FE/BE protocol spec, we'd probably better continue to allow it. Fix by adding tests everywhere that the raw_parse_tree field is passed to functions that don't or shouldn't accept NULL. Also make it clear in the relevant comments that NULL is an expected case. This reverts commits a73c9db and 2e9650c, which fixed specific crash symptoms by hacking things at what now seems to be the wrong end, ie the callee functions. Making the callees allow NULL is superficially more robust, but it's not always true that there is a defensible thing for the callee to do in such cases. The caller has more context and is better able to decide what the empty-query case ought to do. Per followup discussion of bug #11335. Back-patch to 9.2. The code before that is sufficiently different that it would require development of a separate patch, which doesn't seem worthwhile for what is believed to be an essentially cosmetic change.
diff --git a/src/backend/executor/spi.c b/src/backend/executor/spi.c
@@ -1942,7 +1942,9 @@ _SPI_execute_plan(SPIPlanPtr plan, ParamListInfo paramLI,
 			 * Parameter datatypes are driven by parserSetup hook if provided,
 			 * otherwise we use the fixed parameter list.
 			 */
-			if (plan->parserSetup != NULL)
+			if (parsetree == NULL)
+				stmt_list = NIL;
+			else if (plan->parserSetup != NULL)
 			{
 				Assert(plan->nargs == 0);
 				stmt_list = pg_analyze_and_rewrite_params(parsetree,
diff --git a/src/backend/parser/analyze.c b/src/backend/parser/analyze.c
@@ -287,17 +287,13 @@ transformStmt(ParseState *pstate, Node *parseTree)
  *		Returns true if a snapshot must be set before doing parse analysis
  *		on the given raw parse tree.
  *
- * Classification here should match transformStmt(); but we also have to
- * allow a NULL input (for Parse/Bind of an empty query string).
+ * Classification here should match transformStmt().
  */
 bool
 analyze_requires_snapshot(Node *parseTree)
 {
 	bool		result;
 
-	if (parseTree == NULL)
-		return false;
-
 	switch (nodeTag(parseTree))
 	{
 			/*
diff --git a/src/backend/tcop/postgres.c b/src/backend/tcop/postgres.c
@@ -1547,7 +1547,9 @@ exec_bind_message(StringInfo input_message)
 	 * snapshot active till we're done, so that plancache.c doesn't have to
 	 * take new ones.
 	 */
-	if (numParams > 0 || analyze_requires_snapshot(psrc->raw_parse_tree))
+	if (numParams > 0 ||
+		(psrc->raw_parse_tree &&
+		 analyze_requires_snapshot(psrc->raw_parse_tree)))
 	{
 		PushActiveSnapshot(GetTransactionSnapshot());
 		snapshot_set = true;
diff --git a/src/backend/tcop/utility.c b/src/backend/tcop/utility.c
@@ -2184,9 +2184,6 @@ GetCommandLogLevel(Node *parsetree)
 {
 	LogStmtLevel lev;
 
-	if (parsetree == NULL)
-		return LOGSTMT_ALL;
-
 	switch (nodeTag(parsetree))
 	{
 			/* raw plannable queries */
@@ -2290,7 +2287,7 @@ GetCommandLogLevel(Node *parsetree)
 
 				/* Look through an EXECUTE to the referenced stmt */
 				ps = FetchPreparedStatement(stmt->name, false);
-				if (ps)
+				if (ps && ps->plansource->raw_parse_tree)
 					lev = GetCommandLogLevel(ps->plansource->raw_parse_tree);
 				else
 					lev = LOGSTMT_ALL;
diff --git a/src/backend/utils/cache/plancache.c b/src/backend/utils/cache/plancache.c
@@ -136,7 +136,7 @@ InitPlanCache(void)
  * Once constructed, the cached plan can be made longer-lived, if needed,
  * by calling SaveCachedPlan.
  *
- * raw_parse_tree: output of raw_parser()
+ * raw_parse_tree: output of raw_parser(), or NULL if empty query
  * query_string: original query text
  * commandTag: compile-time-constant tag for query, or NULL if empty query
  */
@@ -218,7 +218,7 @@ CreateCachedPlan(Node *raw_parse_tree,
  * invalidation, so plan use must be completed in the current transaction,
  * and DDL that might invalidate the querytree_list must be avoided as well.
  *
- * raw_parse_tree: output of raw_parser()
+ * raw_parse_tree: output of raw_parser(), or NULL if empty query
  * query_string: original query text
  * commandTag: compile-time-constant tag for query, or NULL if empty query
  */
@@ -644,7 +644,9 @@ RevalidateCachedQuery(CachedPlanSource *plansource)
 	 * the cache.
 	 */
 	rawtree = copyObject(plansource->raw_parse_tree);
-	if (plansource->parserSetup != NULL)
+	if (rawtree == NULL)
+		tlist = NIL;
+	else if (plansource->parserSetup != NULL)
 		tlist = pg_analyze_and_rewrite_params(rawtree,
 											  plansource->query_string,
 											  plansource->parserSetup,
@@ -883,6 +885,7 @@ BuildCachedPlan(CachedPlanSource *plansource, List *qlist,
 	 */
 	snapshot_set = false;
 	if (!ActiveSnapshotSet() &&
+		plansource->raw_parse_tree &&
 		analyze_requires_snapshot(plansource->raw_parse_tree))
 	{
 		PushActiveSnapshot(GetTransactionSnapshot());
diff --git a/src/include/utils/plancache.h b/src/include/utils/plancache.h
@@ -76,7 +76,7 @@
 typedef struct CachedPlanSource
 {
 	int			magic;			/* should equal CACHEDPLANSOURCE_MAGIC */
-	Node	   *raw_parse_tree; /* output of raw_parser() */
+	Node	   *raw_parse_tree; /* output of raw_parser(), or NULL */
 	const char *query_string;	/* source text of query */
 	const char *commandTag;		/* command tag (a constant!), or NULL */
 	Oid		   *param_types;	/* array of parameter type OIDs, or NULL */

Original file line number	Diff line number	Diff line change
`@@ -287,17 +287,13 @@ transformStmt(ParseState pstate, Node parseTree)`
`287`	`287`	`* Returns true if a snapshot must be set before doing parse analysis`
`288`	`288`	`* on the given raw parse tree.`
`289`	`289`	`*`
`290`		`- * Classification here should match transformStmt(); but we also have to`
`291`		`- * allow a NULL input (for Parse/Bind of an empty query string).`
	`290`	`+ * Classification here should match transformStmt().`
`292`	`291`	`*/`
`293`	`292`	`bool`
`294`	`293`	`analyze_requires_snapshot(Node *parseTree)`
`295`	`294`	`{`
`296`	`295`	`bool result;`
`297`	`296`
`298`		`- if (parseTree == NULL)`
`299`		`- return false;`
`300`		`-`
`301`	`297`	`switch (nodeTag(parseTree))`
`302`	`298`	`{`
`303`	`299`	`/*`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@`
`76`	`76`	`typedef struct CachedPlanSource`
`77`	`77`	`{`
`78`	`78`	`int magic; /* should equal CACHEDPLANSOURCE_MAGIC */`
`79`		`- Node raw_parse_tree; / output of raw_parser() */`
	`79`	`+ Node raw_parse_tree; / output of raw_parser(), or NULL */`
`80`	`80`	`const char query_string; / source text of query */`
`81`	`81`	`const char commandTag; / command tag (a constant!), or NULL */`
`82`	`82`	`Oid param_types; / array of parameter type OIDs, or NULL */`