Improve and simplify CREATE EXTENSION's management of GUC variables.

CREATE EXTENSION needs to transiently set search_path, as well as
client_min_messages and log_min_messages.  We were doing this by the
expedient of saving the current string value of each variable, doing a
SET LOCAL, and then doing another SET LOCAL with the previous value at
the end of the command.  This is a bit expensive though, and it also fails
badly if there is anything funny about the existing search_path value,
as seen in a recent report from Roger Niederland.  Fortunately, there's a
much better way, which is to piggyback on the GUC infrastructure previously
developed for functions with SET options.  We just open a new GUC nesting
level, do our assignments with GUC_ACTION_SAVE, and then close the nesting
level when done.  This automatically restores the prior settings without a
re-parsing pass, so (in principle anyway) there can't be an error.  And
guc.c still takes care of cleanup in event of an error abort.

The CREATE EXTENSION code for this was modeled on some much older code in
ri_triggers.c, which I also changed to use the better method, even though
there wasn't really much risk of failure there.  Also improve the comments
in guc.c to reflect this additional usage.

diff --git a/src/backend/commands/extension.c b/src/backend/commands/extension.c
index 278bbcfc988e1a11cc904c72d9649f81191be3c4..e5ea12e9200994f4873b9fd12d1a44196b3c5ce9 100644 (file)
--- a/src/backend/commands/extension.c
+++ b/src/backend/commands/extension.c
@@ -776,9 +776,7 @@ execute_extension_script(Oid extensionOid, ExtensionControlFile *control,
                         const char *schemaName, Oid schemaOid)
 {
    char       *filename;
-   char       *save_client_min_messages,
-              *save_log_min_messages,
-              *save_search_path;
+   int         save_nestlevel;
    StringInfoData pathbuf;
    ListCell   *lc;
 
@@ -810,22 +808,20 @@ execute_extension_script(Oid extensionOid, ExtensionControlFile *control,
     * so that we won't spam the user with useless NOTICE messages from common
     * script actions like creating shell types.
     *
-    * We use the equivalent of SET LOCAL to ensure the setting is undone upon
-    * error.
+    * We use the equivalent of a function SET option to allow the setting to
+    * persist for exactly the duration of the script execution.  guc.c also
+    * takes care of undoing the setting on error.
     */
-   save_client_min_messages =
-       pstrdup(GetConfigOption("client_min_messages", false, false));
+   save_nestlevel = NewGUCNestLevel();
+
    if (client_min_messages < WARNING)
        (void) set_config_option("client_min_messages", "warning",
                                 PGC_USERSET, PGC_S_SESSION,
-                                GUC_ACTION_LOCAL, true);
-
-   save_log_min_messages =
-       pstrdup(GetConfigOption("log_min_messages", false, false));
+                                GUC_ACTION_SAVE, true);
    if (log_min_messages < WARNING)
        (void) set_config_option("log_min_messages", "warning",
                                 PGC_SUSET, PGC_S_SESSION,
-                                GUC_ACTION_LOCAL, true);
+                                GUC_ACTION_SAVE, true);
 
    /*
     * Set up the search path to contain the target schema, then the schemas
@@ -834,10 +830,9 @@ execute_extension_script(Oid extensionOid, ExtensionControlFile *control,
     *
     * Note: it might look tempting to use PushOverrideSearchPath for this,
     * but we cannot do that.  We have to actually set the search_path GUC in
-    * case the extension script examines or changes it.
+    * case the extension script examines or changes it.  In any case, the
+    * GUC_ACTION_SAVE method is just as convenient.
     */
-   save_search_path = pstrdup(GetConfigOption("search_path", false, false));
-
    initStringInfo(&pathbuf);
    appendStringInfoString(&pathbuf, quote_identifier(schemaName));
    foreach(lc, requiredSchemas)
@@ -851,7 +846,7 @@ execute_extension_script(Oid extensionOid, ExtensionControlFile *control,
 
    (void) set_config_option("search_path", pathbuf.data,
                             PGC_USERSET, PGC_S_SESSION,
-                            GUC_ACTION_LOCAL, true);
+                            GUC_ACTION_SAVE, true);
 
    /*
     * Set creating_extension and related variables so that
@@ -912,18 +907,9 @@ execute_extension_script(Oid extensionOid, ExtensionControlFile *control,
    CurrentExtensionObject = InvalidOid;
 
    /*
-    * Restore GUC variables for the remainder of the current transaction.
-    * Again use SET LOCAL, so we won't affect the session value.
+    * Restore the GUC variables we set above.
     */
-   (void) set_config_option("search_path", save_search_path,
-                            PGC_USERSET, PGC_S_SESSION,
-                            GUC_ACTION_LOCAL, true);
-   (void) set_config_option("client_min_messages", save_client_min_messages,
-                            PGC_USERSET, PGC_S_SESSION,
-                            GUC_ACTION_LOCAL, true);
-   (void) set_config_option("log_min_messages", save_log_min_messages,
-                            PGC_SUSET, PGC_S_SESSION,
-                            GUC_ACTION_LOCAL, true);
+   AtEOXact_GUC(true, save_nestlevel);
 }
 
 /*

diff --git a/src/backend/utils/adt/ri_triggers.c b/src/backend/utils/adt/ri_triggers.c
index fa7b8e6e81a6dea5e580ac503e13c88f0f6c78bd..f08af12a2bd5e261926141932fded850c50228ed 100644 (file)
--- a/src/backend/utils/adt/ri_triggers.c
+++ b/src/backend/utils/adt/ri_triggers.c
@@ -2633,7 +2633,7 @@ RI_Initial_Check(Trigger *trigger, Relation fk_rel, Relation pk_rel)
    RangeTblEntry *fkrte;
    const char *sep;
    int         i;
-   int         old_work_mem;
+   int         save_nestlevel;
    char        workmembuf[32];
    int         spi_result;
    SPIPlanPtr  qplan;
@@ -2772,14 +2772,16 @@ RI_Initial_Check(Trigger *trigger, Relation fk_rel, Relation pk_rel)
     * this seems to meet the criteria for being considered a "maintenance"
     * operation, and accordingly we use maintenance_work_mem.
     *
-    * We do the equivalent of "SET LOCAL work_mem" so that transaction abort
-    * will restore the old value if we lose control due to an error.
+    * We use the equivalent of a function SET option to allow the setting to
+    * persist for exactly the duration of the check query.  guc.c also takes
+    * care of undoing the setting on error.
     */
-   old_work_mem = work_mem;
+   save_nestlevel = NewGUCNestLevel();
+
    snprintf(workmembuf, sizeof(workmembuf), "%d", maintenance_work_mem);
    (void) set_config_option("work_mem", workmembuf,
                             PGC_USERSET, PGC_S_SESSION,
-                            GUC_ACTION_LOCAL, true);
+                            GUC_ACTION_SAVE, true);
 
    if (SPI_connect() != SPI_OK_CONNECT)
        elog(ERROR, "SPI_connect failed");
@@ -2862,13 +2864,9 @@ RI_Initial_Check(Trigger *trigger, Relation fk_rel, Relation pk_rel)
        elog(ERROR, "SPI_finish failed");
 
    /*
-    * Restore work_mem for the remainder of the current transaction. This is
-    * another SET LOCAL, so it won't affect the session value.
+    * Restore work_mem.
     */
-   snprintf(workmembuf, sizeof(workmembuf), "%d", old_work_mem);
-   (void) set_config_option("work_mem", workmembuf,
-                            PGC_USERSET, PGC_S_SESSION,
-                            GUC_ACTION_LOCAL, true);
+   AtEOXact_GUC(true, save_nestlevel);
 
    return true;
 }

diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
index 5cc90fbe51f73affdf7ecd63b1ffe7ae4515b2c8..e9b665095dcd950f6c6854fc0eb77789abc67e10 100644 (file)
--- a/src/backend/utils/misc/guc.c
+++ b/src/backend/utils/misc/guc.c
@@ -4367,8 +4367,9 @@ AtStart_GUC(void)
 
 /*
  * Enter a new nesting level for GUC values.  This is called at subtransaction
- * start and when entering a function that has proconfig settings. NOTE that
- * we must not risk error here, else subtransaction start will be unhappy.
+ * start, and when entering a function that has proconfig settings, and in
+ * some other places where we want to set GUC variables transiently.
+ * NOTE we must not risk error here, else subtransaction start will be unhappy.
  */
 int
 NewGUCNestLevel(void)
@@ -4378,8 +4379,9 @@ NewGUCNestLevel(void)
 
 /*
  * Do GUC processing at transaction or subtransaction commit or abort, or
- * when exiting a function that has proconfig settings.  (The name is thus
- * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
+ * when exiting a function that has proconfig settings, or when undoing a
+ * transient assignment to some GUC variables.  (The name is thus a bit of
+ * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
  * During abort, we discard all GUC settings that were applied at nesting
  * levels >= nestLevel.  nestLevel == 1 corresponds to the main transaction.
  */
@@ -4412,11 +4414,11 @@ AtEOXact_GUC(bool isCommit, int nestLevel)
        GucStack   *stack;
 
        /*
-        * Process and pop each stack entry within the nest level.  To
-        * simplify fmgr_security_definer(), we allow failure exit from a
-        * function-with-SET-options to be recovered at the surrounding
-        * transaction or subtransaction abort; so there could be more than
-        * one stack entry to pop.
+        * Process and pop each stack entry within the nest level. To simplify
+        * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
+        * we allow failure exit from code that uses a local nest level to be
+        * recovered at the surrounding transaction or subtransaction abort;
+        * so there could be more than one stack entry to pop.
         */
        while ((stack = gconf->stack) != NULL &&
               stack->nest_level >= nestLevel)

diff --git a/src/include/utils/guc.h b/src/include/utils/guc.h
index 011f6b7f001a60ce1fcfb732264238f5d355866d..8975561b20e1276af9900303ef4073a364b84a8d 100644 (file)
--- a/src/include/utils/guc.h
+++ b/src/include/utils/guc.h
@@ -155,7 +155,7 @@ typedef enum
    /* Types of set_config_option actions */
    GUC_ACTION_SET,             /* regular SET command */
    GUC_ACTION_LOCAL,           /* SET LOCAL command */
-   GUC_ACTION_SAVE             /* function SET option */
+   GUC_ACTION_SAVE             /* function SET option, or temp assignment */
 } GucAction;
 
 #define GUC_QUALIFIER_SEPARATOR '.'