Be more wary about NULL values for GUC string variables.

tglsfdc · tglsfdc · commit 82063edd4ac3 · 2023-11-02T11:47:33.000-04:00
get_explain_guc_options() crashed if a string GUC marked GUC_EXPLAIN has a NULL boot_val. Nosing around found a couple of other places that seemed insufficiently cautious about NULL string values, although those are likely unreachable in practice. Add some commentary defining the expectations for NULL values of string variables, in hopes of forestalling future additions of more such bugs. Xing Guo, Aleksander Alekseev, Tom Lane Discussion: https://postgr.es/m/CACpMh+AyDx5YUpPaAgzVwC1d8zfOL4JoD-uyFDnNSa1z0EsDQQ@mail.gmail.com
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
@@ -1445,7 +1445,9 @@ check_GUC_init(struct config_generic *gconf)
 			{
 				struct config_string *conf = (struct config_string *) gconf;
 
-				if (*conf->variable != NULL && strcmp(*conf->variable, conf->boot_val) != 0)
+				if (*conf->variable != NULL &&
+					(conf->boot_val == NULL ||
+					 strcmp(*conf->variable, conf->boot_val) != 0))
 				{
 					elog(LOG, "GUC (PGC_STRING) %s, boot_val=%s, C-var=%s",
 						 conf->gen.name, conf->boot_val ? conf->boot_val : "<null>", *conf->variable);
@@ -5215,7 +5217,14 @@ get_explain_guc_options(int *num)
 				{
 					struct config_string *lconf = (struct config_string *) conf;
 
-					modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
+					if (lconf->boot_val == NULL &&
+						*lconf->variable == NULL)
+						modified = false;
+					else if (lconf->boot_val == NULL ||
+							 *lconf->variable == NULL)
+						modified = true;
+					else
+						modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
 				}
 				break;
 
@@ -5442,7 +5451,8 @@ write_one_nondefault_variable(FILE *fp, struct config_generic *gconf)
 			{
 				struct config_string *conf = (struct config_string *) gconf;
 
-				fprintf(fp, "%s", *conf->variable);
+				if (*conf->variable)
+					fprintf(fp, "%s", *conf->variable);
 			}
 			break;
 
diff --git a/src/include/utils/guc_tables.h b/src/include/utils/guc_tables.h
@@ -240,6 +240,16 @@ struct config_real
 	void	   *reset_extra;
 };
 
+/*
+ * A note about string GUCs: the boot_val is allowed to be NULL, which leads
+ * to the reset_val and the actual variable value (*variable) also being NULL.
+ * However, there is no way to set a NULL value subsequently using
+ * set_config_option or any other GUC API.  Also, GUC APIs such as SHOW will
+ * display a NULL value as an empty string.  Callers that choose to use a NULL
+ * boot_val should overwrite the setting later in startup, or else be careful
+ * that NULL doesn't have semantics that are visibly different from an empty
+ * string.
+ */
 struct config_string
 {
 	struct config_generic gen;

Original file line number	Diff line number	Diff line change
`@@ -1445,7 +1445,9 @@ check_GUC_init(struct config_generic *gconf)`
`1445`	`1445`	`{`
`1446`	`1446`	`struct config_string conf = (struct config_string ) gconf;`
`1447`	`1447`
`1448`		`- if (conf->variable != NULL && strcmp(conf->variable, conf->boot_val) != 0)`
	`1448`	`+ if (*conf->variable != NULL &&`
	`1449`	`+ (conf->boot_val == NULL \|\|`
	`1450`	`+ strcmp(*conf->variable, conf->boot_val) != 0))`
`1449`	`1451`	`{`
`1450`	`1452`	`elog(LOG, "GUC (PGC_STRING) %s, boot_val=%s, C-var=%s",`
`1451`	`1453`	`conf->gen.name, conf->boot_val ? conf->boot_val : "<null>", *conf->variable);`
`@@ -5215,7 +5217,14 @@ get_explain_guc_options(int *num)`
`5215`	`5217`	`{`
`5216`	`5218`	`struct config_string lconf = (struct config_string ) conf;`
`5217`	`5219`
`5218`		`- modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);`
	`5220`	`+ if (lconf->boot_val == NULL &&`
	`5221`	`+ *lconf->variable == NULL)`
	`5222`	`+ modified = false;`
	`5223`	`+ else if (lconf->boot_val == NULL \|\|`
	`5224`	`+ *lconf->variable == NULL)`
	`5225`	`+ modified = true;`
	`5226`	`+ else`
	`5227`	`+ modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);`
`5219`	`5228`	`}`
`5220`	`5229`	`break;`
`5221`	`5230`
`@@ -5442,7 +5451,8 @@ write_one_nondefault_variable(FILE fp, struct config_generic gconf)`
`5442`	`5451`	`{`
`5443`	`5452`	`struct config_string conf = (struct config_string ) gconf;`
`5444`	`5453`
`5445`		`- fprintf(fp, "%s", *conf->variable);`
	`5454`	`+ if (*conf->variable)`
	`5455`	`+ fprintf(fp, "%s", *conf->variable);`
`5446`	`5456`	`}`
`5447`	`5457`	`break;`
`5448`	`5458`