Commit 82a47982 authored by Tom Lane's avatar Tom Lane

Arrange for SET LOCAL's effects to persist until the end of the current top

transaction, unless rolled back or overridden by a SET clause for the same
variable attached to a surrounding function call.  Per discussion, these
seem the best semantics.  Note that this is an INCOMPATIBLE CHANGE: in 8.0
through 8.2, SET LOCAL's effects disappeared at subtransaction commit
(leading to behavior that made little sense at the SQL level).

I took advantage of the opportunity to rewrite and simplify the GUC variable
save/restore logic a little bit.  The old idea of a "tentative" value is gone;
it was a hangover from before we had a stack.  Also, we no longer need a stack
entry for every nesting level, but only for those in which a variable's value
actually changed.
parent b366562e
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/create_function.sgml,v 1.77 2007/09/03 18:46:29 tgl Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/create_function.sgml,v 1.78 2007/09/11 00:06:41 tgl Exp $
--> -->
<refentry id="SQL-CREATEFUNCTION"> <refentry id="SQL-CREATEFUNCTION">
...@@ -475,11 +475,11 @@ CREATE FUNCTION foo(int, out text) ... ...@@ -475,11 +475,11 @@ CREATE FUNCTION foo(int, out text) ...
</para> </para>
<para> <para>
If any <literal>SET</> clauses are attached to a function, then If a <literal>SET</> clause is attached to a function, then
the effects of a <command>SET LOCAL</> command executed inside the the effects of a <command>SET LOCAL</> command executed inside the
function are restricted to the function: the configuration parameter's function for the same variable are restricted to the function: the
value is restored at function exit. This is true even for parameters configuration parameter's prior value is still restored at function exit.
not mentioned in the <literal>SET</> clause(s). However, an ordinary However, an ordinary
<command>SET</> command (without <literal>LOCAL</>) overrides the <command>SET</> command (without <literal>LOCAL</>) overrides the
<literal>SET</> clause, much as it would do for a previous <command>SET <literal>SET</> clause, much as it would do for a previous <command>SET
LOCAL</> command: the effects of such a command will persist after LOCAL</> command: the effects of such a command will persist after
......
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/prepare_transaction.sgml,v 1.5 2006/09/16 00:30:19 momjian Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/prepare_transaction.sgml,v 1.6 2007/09/11 00:06:41 tgl Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -94,7 +94,8 @@ PREPARE TRANSACTION <replaceable class="PARAMETER">transaction_id</replaceable> ...@@ -94,7 +94,8 @@ PREPARE TRANSACTION <replaceable class="PARAMETER">transaction_id</replaceable>
</para> </para>
<para> <para>
If the transaction modified any run-time parameters with <command>SET</>, If the transaction modified any run-time parameters with <command>SET</>
(without the <literal>LOCAL</> option),
those effects persist after <command>PREPARE TRANSACTION</>, and will not those effects persist after <command>PREPARE TRANSACTION</>, and will not
be affected by any later <command>COMMIT PREPARED</command> or be affected by any later <command>COMMIT PREPARED</command> or
<command>ROLLBACK PREPARED</command>. Thus, in this one respect <command>ROLLBACK PREPARED</command>. Thus, in this one respect
......
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.35 2007/04/26 16:13:09 neilc Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.36 2007/09/11 00:06:41 tgl Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -44,13 +44,16 @@ SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFA ...@@ -44,13 +44,16 @@ SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFA
have had, if no <command>SET</> had ever been issued for it in the have had, if no <command>SET</> had ever been issued for it in the
current session. The actual source of this value might be a current session. The actual source of this value might be a
compiled-in default, the configuration file, command-line options, compiled-in default, the configuration file, command-line options,
or per-database or per-user default settings. See <xref or per-database or per-user default settings. This is subtly different
linkend="runtime-config"> for details. from defining it as <quote>the value that the parameter had at session
start</>, because if the value came from the configuration file, it
will be reset to whatever is specified by the configuration file now.
See <xref linkend="runtime-config"> for details.
</para> </para>
<para> <para>
See the <command>SET</> reference page for details on the The transactional behavior of <command>RESET</> is the same as
transaction behavior of <command>RESET</>. <command>SET</>: its effects will be undone by transaction rollback.
</para> </para>
</refsect1> </refsect1>
...@@ -62,8 +65,9 @@ SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFA ...@@ -62,8 +65,9 @@ SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFA
<term><replaceable class="PARAMETER">configuration_parameter</replaceable></term> <term><replaceable class="PARAMETER">configuration_parameter</replaceable></term>
<listitem> <listitem>
<para> <para>
The name of a run-time parameter. See <xref linkend="sql-set" Name of a settable run-time parameter. Available parameters are
endterm="sql-set-title"> for a list. documented in <xref linkend="runtime-config"> and on the
<xref linkend="sql-set" endterm="sql-set-title"> reference page.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -83,9 +87,9 @@ SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFA ...@@ -83,9 +87,9 @@ SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFA
<title>Examples</title> <title>Examples</title>
<para> <para>
Set the <varname>geqo</> configuration variable to its default value: Set the <varname>timezone</> configuration variable to its default value:
<screen> <screen>
RESET geqo; RESET timezone;
</screen> </screen>
</para> </para>
</refsect1> </refsect1>
...@@ -97,4 +101,13 @@ RESET geqo; ...@@ -97,4 +101,13 @@ RESET geqo;
<command>RESET</command> is a <productname>PostgreSQL</productname> extension. <command>RESET</command> is a <productname>PostgreSQL</productname> extension.
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="SQL-SET" endterm="SQL-SET-title"></member>
<member><xref linkend="SQL-SHOW" endterm="SQL-SHOW-title"></member>
</simplelist>
</refsect1>
</refentry> </refentry>
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/set.sgml,v 1.90 2006/09/22 16:20:00 tgl Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/set.sgml,v 1.91 2007/09/11 00:06:41 tgl Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -40,13 +40,10 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep ...@@ -40,13 +40,10 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep
</para> </para>
<para> <para>
If <command>SET</command> or <command>SET SESSION</command> is issued If <command>SET</command> (or equivalently <command>SET SESSION</command>)
within a transaction that is later aborted, the effects of the is issued within a transaction that is later aborted, the effects of the
<command>SET</command> command disappear when the transaction is rolled <command>SET</command> command disappear when the transaction is rolled
back. (This behavior represents a change from back. Once the surrounding transaction is committed, the effects
<productname>PostgreSQL</productname> versions prior to 7.3, where
the effects of <command>SET</command> would not roll back after a later
error.) Once the surrounding transaction is committed, the effects
will persist until the end of the session, unless overridden by another will persist until the end of the session, unless overridden by another
<command>SET</command>. <command>SET</command>.
</para> </para>
...@@ -59,6 +56,36 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep ...@@ -59,6 +56,36 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep
seen until the end of the transaction, but afterwards (if the transaction seen until the end of the transaction, but afterwards (if the transaction
is committed) the <command>SET</command> value will take effect. is committed) the <command>SET</command> value will take effect.
</para> </para>
<para>
The effects of <command>SET</command> or <command>SET LOCAL</command> are
also canceled by rolling back to a savepoint that is earlier than the
command.
</para>
<para>
If <command>SET LOCAL</command> is used within a function that has a
<literal>SET</> option for the same variable (see
<xref linkend="sql-createfunction" endterm="sql-createfunction-title">),
the effects of the <command>SET LOCAL</command> command disappear at
function exit; that is, the value in effect when the function was called is
restored anyway. This allows <command>SET LOCAL</command> to be used for
dynamic or repeated changes of a parameter within a function, while still
having the convenience of using the <literal>SET</> option to save and
restore the caller's value. However, a regular <command>SET</> command
overrides any surrounding function's <literal>SET</> option; its effects
will persist unless rolled back.
</para>
<note>
<para>
In <productname>PostgreSQL</productname> versions 8.0 through 8.2,
the effects of a <command>SET LOCAL</command> would be canceled by
releasing an earlier savepoint, or by successful exit from a
<application>PL/pgSQL</application> exception block. This behavior
has been changed because it was deemed unintuitive.
</para>
</note>
</refsect1> </refsect1>
<refsect1> <refsect1>
...@@ -106,8 +133,11 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep ...@@ -106,8 +133,11 @@ SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</rep
<para> <para>
New value of parameter. Values can be specified as string New value of parameter. Values can be specified as string
constants, identifiers, numbers, or comma-separated lists of constants, identifiers, numbers, or comma-separated lists of
these. <literal>DEFAULT</literal> can be used to specify these, as appropriate for the particular parameter.
resetting the parameter to its default value. <literal>DEFAULT</literal> can be written to specify
resetting the parameter to its default value (that is, whatever
value it would have had if no <command>SET</> had been executed
in the current session).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -200,7 +230,9 @@ SELECT setseed(<replaceable>value</replaceable>); ...@@ -200,7 +230,9 @@ SELECT setseed(<replaceable>value</replaceable>);
<term><literal>DEFAULT</literal></term> <term><literal>DEFAULT</literal></term>
<listitem> <listitem>
<para> <para>
Set the time zone to your local time zone (the one that Set the time zone to your local time zone (that is, the
server's default value of <varname>timezone</>; if this
has not been explicitly set anywhere, it will be the zone that
the server's operating system defaults to). the server's operating system defaults to).
</para> </para>
</listitem> </listitem>
...@@ -221,7 +253,10 @@ SELECT setseed(<replaceable>value</replaceable>); ...@@ -221,7 +253,10 @@ SELECT setseed(<replaceable>value</replaceable>);
<para> <para>
The function <function>set_config</function> provides equivalent The function <function>set_config</function> provides equivalent
functionality. See <xref linkend="functions-admin">. functionality; see <xref linkend="functions-admin">.
Also, it is possible to UPDATE the
<link linkend="view-pg-settings"><structname>pg_settings</structname></link>
system view to perform the equivalent of <command>SET</>.
</para> </para>
</refsect1> </refsect1>
......
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/show.sgml,v 1.42 2006/09/16 00:30:20 momjian Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/show.sgml,v 1.43 2007/09/11 00:06:41 tgl Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -36,7 +36,7 @@ SHOW ALL ...@@ -36,7 +36,7 @@ SHOW ALL
the <envar>PGOPTIONS</envar> environmental variable (when using the <envar>PGOPTIONS</envar> environmental variable (when using
<application>libpq</> or a <application>libpq</>-based <application>libpq</> or a <application>libpq</>-based
application), or through command-line flags when starting the application), or through command-line flags when starting the
<command>postgres</command>. See <xref <command>postgres</command> server. See <xref
linkend="runtime-config"> for details. linkend="runtime-config"> for details.
</para> </para>
</refsect1> </refsect1>
...@@ -130,7 +130,11 @@ SHOW ALL ...@@ -130,7 +130,11 @@ SHOW ALL
<para> <para>
The function <function>current_setting</function> produces The function <function>current_setting</function> produces
equivalent output. See <xref linkend="functions-admin">. equivalent output; see <xref linkend="functions-admin">.
Also, the
<link linkend="view-pg-settings"><structname>pg_settings</structname></link>
system view produces the same information.
</para> </para>
</refsect1> </refsect1>
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* *
* Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
* *
* $PostgreSQL: pgsql/src/backend/utils/adt/ri_triggers.c,v 1.96 2007/08/15 19:15:46 tgl Exp $ * $PostgreSQL: pgsql/src/backend/utils/adt/ri_triggers.c,v 1.97 2007/09/11 00:06:42 tgl Exp $
* *
* ---------- * ----------
*/ */
...@@ -2749,7 +2749,7 @@ RI_Initial_Check(Trigger *trigger, Relation fk_rel, Relation pk_rel) ...@@ -2749,7 +2749,7 @@ RI_Initial_Check(Trigger *trigger, Relation fk_rel, Relation pk_rel)
snprintf(workmembuf, sizeof(workmembuf), "%d", maintenance_work_mem); snprintf(workmembuf, sizeof(workmembuf), "%d", maintenance_work_mem);
(void) set_config_option("work_mem", workmembuf, (void) set_config_option("work_mem", workmembuf,
PGC_USERSET, PGC_S_SESSION, PGC_USERSET, PGC_S_SESSION,
true, true); GUC_ACTION_LOCAL, true);
if (SPI_connect() != SPI_OK_CONNECT) if (SPI_connect() != SPI_OK_CONNECT)
elog(ERROR, "SPI_connect failed"); elog(ERROR, "SPI_connect failed");
...@@ -2832,13 +2832,12 @@ RI_Initial_Check(Trigger *trigger, Relation fk_rel, Relation pk_rel) ...@@ -2832,13 +2832,12 @@ RI_Initial_Check(Trigger *trigger, Relation fk_rel, Relation pk_rel)
/* /*
* Restore work_mem for the remainder of the current transaction. This is * Restore work_mem for the remainder of the current transaction. This is
* another SET LOCAL, so it won't affect the session value, nor any * another SET LOCAL, so it won't affect the session value.
* tentative value if there is one.
*/ */
snprintf(workmembuf, sizeof(workmembuf), "%d", old_work_mem); snprintf(workmembuf, sizeof(workmembuf), "%d", old_work_mem);
(void) set_config_option("work_mem", workmembuf, (void) set_config_option("work_mem", workmembuf,
PGC_USERSET, PGC_S_SESSION, PGC_USERSET, PGC_S_SESSION,
true, true); GUC_ACTION_LOCAL, true);
return true; return true;
} }
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
* *
* *
* IDENTIFICATION * IDENTIFICATION
* $PostgreSQL: pgsql/src/backend/utils/fmgr/fmgr.c,v 1.109 2007/09/03 00:39:18 tgl Exp $ * $PostgreSQL: pgsql/src/backend/utils/fmgr/fmgr.c,v 1.110 2007/09/11 00:06:42 tgl Exp $
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
*/ */
...@@ -925,11 +925,10 @@ fmgr_security_definer(PG_FUNCTION_ARGS) ...@@ -925,11 +925,10 @@ fmgr_security_definer(PG_FUNCTION_ARGS)
if (fcache->proconfig) if (fcache->proconfig)
{ {
/* The options are processed as if by SET LOCAL var = val */
ProcessGUCArray(fcache->proconfig, ProcessGUCArray(fcache->proconfig,
(superuser() ? PGC_SUSET : PGC_USERSET), (superuser() ? PGC_SUSET : PGC_USERSET),
PGC_S_SESSION, PGC_S_SESSION,
true); GUC_ACTION_SAVE);
} }
result = FunctionCallInvoke(fcinfo); result = FunctionCallInvoke(fcinfo);
...@@ -937,8 +936,7 @@ fmgr_security_definer(PG_FUNCTION_ARGS) ...@@ -937,8 +936,7 @@ fmgr_security_definer(PG_FUNCTION_ARGS)
PG_CATCH(); PG_CATCH();
{ {
fcinfo->flinfo = save_flinfo; fcinfo->flinfo = save_flinfo;
if (fcache->proconfig) /* We don't need to restore GUC settings, outer xact abort will */
AtEOXact_GUC(false, save_nestlevel);
if (OidIsValid(fcache->userid)) if (OidIsValid(fcache->userid))
SetUserId(save_userid); SetUserId(save_userid);
PG_RE_THROW(); PG_RE_THROW();
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
* *
* *
* IDENTIFICATION * IDENTIFICATION
* $PostgreSQL: pgsql/src/backend/utils/init/miscinit.c,v 1.163 2007/09/03 00:39:18 tgl Exp $ * $PostgreSQL: pgsql/src/backend/utils/init/miscinit.c,v 1.164 2007/09/11 00:06:42 tgl Exp $
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
*/ */
...@@ -453,7 +453,7 @@ InitializeSessionUserId(const char *rolename) ...@@ -453,7 +453,7 @@ InitializeSessionUserId(const char *rolename)
* right to insert an option into pg_authid was checked when it was * right to insert an option into pg_authid was checked when it was
* inserted. * inserted.
*/ */
ProcessGUCArray(a, PGC_SUSET, PGC_S_USER, false); ProcessGUCArray(a, PGC_SUSET, PGC_S_USER, GUC_ACTION_SET);
} }
ReleaseSysCache(roleTup); ReleaseSysCache(roleTup);
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
* *
* *
* IDENTIFICATION * IDENTIFICATION
* $PostgreSQL: pgsql/src/backend/utils/init/postinit.c,v 1.177 2007/09/03 00:39:18 tgl Exp $ * $PostgreSQL: pgsql/src/backend/utils/init/postinit.c,v 1.178 2007/09/11 00:06:42 tgl Exp $
* *
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
...@@ -255,7 +255,7 @@ CheckMyDatabase(const char *name, bool am_superuser) ...@@ -255,7 +255,7 @@ CheckMyDatabase(const char *name, bool am_superuser)
* right to insert an option into pg_database was checked when it * right to insert an option into pg_database was checked when it
* was inserted. * was inserted.
*/ */
ProcessGUCArray(a, PGC_SUSET, PGC_S_DATABASE, false); ProcessGUCArray(a, PGC_SUSET, PGC_S_DATABASE, GUC_ACTION_SET);
} }
} }
......
$PostgreSQL: pgsql/src/backend/utils/misc/README,v 1.6 2007/09/10 00:57:21 tgl Exp $ $PostgreSQL: pgsql/src/backend/utils/misc/README,v 1.7 2007/09/11 00:06:42 tgl Exp $
GUC IMPLEMENTATION NOTES GUC IMPLEMENTATION NOTES
...@@ -69,74 +69,133 @@ by SHOW. ...@@ -69,74 +69,133 @@ by SHOW.
SAVING/RESTORING GUC VARIABLE VALUES SAVING/RESTORING GUC VARIABLE VALUES
Prior values of configuration variables must be remembered in order to Prior values of configuration variables must be remembered in order to deal
deal with three special cases: RESET (a/k/a SET TO DEFAULT), rollback of with several special cases: RESET (a/k/a SET TO DEFAULT), rollback of SET
SET on transaction abort, and rollback of SET LOCAL at transaction end on transaction abort, rollback of SET LOCAL at transaction end (either
(either commit or abort). RESET is defined as selecting the value that commit or abort), and save/restore around a function that has a SET option.
would be effective had there never been any SET commands in the current RESET is defined as selecting the value that would be effective had there
session. never been any SET commands in the current session.
To handle these cases we must keep track of many distinct values for each To handle these cases we must keep track of many distinct values for each
variable. The primary values are: variable. The primary values are:
* actual variable contents always the current effective value * actual variable contents always the current effective value
* reset_value the value to use for RESET * reset_val the value to use for RESET
(Each GUC entry also has a boot_val which is the wired-in default value.
This is assigned to the reset_val and the actual variable during
InitializeGUCOptions(). The boot_val is also consulted to restore the
correct reset_val if SIGHUP processing discovers that a variable formerly
specified in postgresql.conf is no longer set there.)
In addition to the primary values, there is a stack of former effective
values that might need to be restored in future. Stacking and unstacking
is controlled by the GUC "nest level", which is zero when outside any
transaction, one at top transaction level, and incremented for each
open subtransaction or function call with a SET option. A stack entry
is made whenever a GUC variable is first modified at a given nesting level.
(Note: the reset_val need not be stacked because it is only changed by
non-transactional operations.)
A stack entry has a state, a prior value of the GUC variable, a remembered
source of that prior value, and depending on the state may also have a
"masked" value. The masked value is needed when SET followed by SET LOCAL
occur at the same nest level: the SET's value is masked but must be
remembered to restore after transaction commit.
During initialization we set the actual value and reset_val based on
whichever non-interactive source has the highest priority. They will
have the same value.
* tentative_value the uncommitted result of SET The possible transactional operations on a GUC value are:
The reason we need a tentative_value separate from the actual value is Entry to a function with a SET option:
that when a transaction does SET followed by SET LOCAL, the actual value
will now be the LOCAL value, but we want to remember the prior SET so that
that value is restored at transaction commit.
In addition, for each level of transaction (possibly nested) we have to Push a stack entry with the prior variable value and state SAVE,
remember the transaction-entry-time actual and tentative values, in case then set the variable.
we need to restore them at transaction end. (The RESET value is essentially
non-transactional, so it doesn't have to be stacked.) For efficiency these
stack entries are not constructed until/unless the variable is actually SET
within a particular transaction.
During initialization we set the actual value and reset_value based on Plain SET command:
whichever non-interactive source has the highest priority. They will
have the same value. The tentative_value is not meaningful at this point. If no stack entry of current level:
Push new stack entry w/prior value and state SET
else if stack entry's state is SAVE, SET, or LOCAL:
change stack state to SET, don't change saved value
(here we are forgetting effects of prior set action)
else (entry must have state SET+LOCAL):
discard its masked value, change state to SET
(here we are forgetting effects of prior SET and SET LOCAL)
Now set new value.
SET LOCAL command:
If no stack entry of current level:
Push new stack entry w/prior value and state LOCAL
else if stack entry's state is SAVE or LOCAL or SET+LOCAL:
no change to stack entry
(in SAVE case, SET LOCAL will be forgotten at func exit)
else (entry must have state SET):
put current active into its masked slot, set state SET+LOCAL
Now set new value.
Transaction or subtransaction abort:
Pop stack entries, restoring prior value, until top < subxact depth
A SET command starts by stacking the existing actual and tentative values Transaction or subtransaction commit (incl. successful function exit):
if this hasn't already been done within the current transaction. Then:
A SET LOCAL command sets the actual variable (and nothing else). At While stack entry level >= subxact depth
transaction end, the stacked values are used to restore the GUC entry
to its pre-transaction state.
A SET (or SET SESSION) command sets the actual variable, and if no error, if entry's state is SAVE:
then sets the tentative_value. If the transaction commits, the pop, restoring prior value
tentative_value is assigned again to the actual variable (which could by else if level is 1 and entry's state is SET+LOCAL:
now be different, if the SET was followed by SET LOCAL). If the pop, restoring *masked* value
transaction aborts, the stacked values are used to restore the GUC entry else if level is 1 and entry's state is SET:
to its pre-transaction state. pop, discarding old value
else if level is 1 and entry's state is LOCAL:
pop, restoring prior value
else if there is no entry of exactly level N-1:
decrement entry's level, no other state change
else
merge entries of level N-1 and N as specified below
In the case of SET within nested subtransactions, at each commit the The merged entry will have level N-1 and prior = older prior, so easiest
tentative_value propagates out to the next transaction level. It will to keep older entry and free newer. There are 12 possibilities since
be thrown away at abort of any level, or after exiting the top transaction. we already handled level N state = SAVE:
RESET is executed like a SET, but using the reset_value as the desired new N-1 N
SAVE SET discard top prior, set state SET
SAVE LOCAL discard top prior, no change to stack entry
SAVE SET+LOCAL discard top prior, copy masked, state S+L
SET SET discard top prior, no change to stack entry
SET LOCAL copy top prior to masked, state S+L
SET SET+LOCAL discard top prior, copy masked, state S+L
LOCAL SET discard top prior, set state SET
LOCAL LOCAL discard top prior, no change to stack entry
LOCAL SET+LOCAL discard top prior, copy masked, state S+L
SET+LOCAL SET discard top prior and second masked, state SET
SET+LOCAL LOCAL discard top prior, no change to stack entry
SET+LOCAL SET+LOCAL discard top prior, copy masked, state S+L
RESET is executed like a SET, but using the reset_val as the desired new
value. (We do not provide a RESET LOCAL command, but SET LOCAL TO DEFAULT value. (We do not provide a RESET LOCAL command, but SET LOCAL TO DEFAULT
has the same behavior that RESET LOCAL would.) The source associated with has the same behavior that RESET LOCAL would.) The source associated with
the reset_value also becomes associated with the actual and tentative values. the reset_val also becomes associated with the actual value.
If SIGHUP is received, the GUC code rereads the postgresql.conf If SIGHUP is received, the GUC code rereads the postgresql.conf
configuration file (this does not happen in the signal handler, but at configuration file (this does not happen in the signal handler, but at
next return to main loop; note that it can be executed while within a next return to main loop; note that it can be executed while within a
transaction). New values from postgresql.conf are assigned to actual transaction). New values from postgresql.conf are assigned to actual
variable, reset_value, and stacked actual values, but only if each of variable, reset_val, and stacked actual values, but only if each of
these has a current source priority <= PGC_S_FILE. (It is thus possible these has a current source priority <= PGC_S_FILE. (It is thus possible
for reset_value to track the config-file setting even if there is for reset_val to track the config-file setting even if there is
currently a different interactive value of the actual variable.) currently a different interactive value of the actual variable.)
Note that tentative_value is unused and undefined except between a SET
command and the end of the transaction. Also notice that we must track
the source associated with each one of the values.
The assign_hook and show_hook routines work only with the actual variable, The assign_hook and show_hook routines work only with the actual variable,
and are not directly aware of the additional values maintained by GUC. and are not directly aware of the additional values maintained by GUC.
This is not a problem for normal usage, since we can assign first to the This is not a problem for normal usage, since we can assign first to the
...@@ -154,9 +213,9 @@ pstrdup/palloc mechanisms. We would need to keep them in a permanent ...@@ -154,9 +213,9 @@ pstrdup/palloc mechanisms. We would need to keep them in a permanent
context anyway, and strdup gives us more control over handling context anyway, and strdup gives us more control over handling
out-of-memory failures. out-of-memory failures.
We allow a string variable's actual value, reset_val, tentative_val, and We allow a string variable's actual value, reset_val, boot_val, and stacked
stacked copies of same to point at the same storage. This makes it values to point at the same storage. This makes it slightly harder to free
slightly harder to free space (must test whether a value to be freed isn't space (we must test whether a value to be freed isn't equal to any of the
equal to any of the other pointers in the GUC entry or associated stack other pointers in the GUC entry or associated stack items). The main
items). The main advantage is that we never need to strdup during advantage is that we never need to strdup during transaction commit/abort,
transaction commit/abort, so cannot cause an out-of-memory failure there. so cannot cause an out-of-memory failure there.
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
* *
* Copyright (c) 2000-2007, PostgreSQL Global Development Group * Copyright (c) 2000-2007, PostgreSQL Global Development Group
* *
* $PostgreSQL: pgsql/src/backend/utils/misc/guc-file.l,v 1.51 2007/09/10 00:57:21 tgl Exp $ * $PostgreSQL: pgsql/src/backend/utils/misc/guc-file.l,v 1.52 2007/09/11 00:06:42 tgl Exp $
*/ */
%{ %{
...@@ -231,7 +231,7 @@ ProcessConfigFile(GucContext context) ...@@ -231,7 +231,7 @@ ProcessConfigFile(GucContext context)
} }
if (!set_config_option(item->name, item->value, context, if (!set_config_option(item->name, item->value, context,
PGC_S_FILE, false, false)) PGC_S_FILE, GUC_ACTION_SET, false))
goto cleanup_list; goto cleanup_list;
} }
...@@ -264,24 +264,21 @@ ProcessConfigFile(GucContext context) ...@@ -264,24 +264,21 @@ ProcessConfigFile(GucContext context)
/* /*
* Reset any "file" sources to "default", else set_config_option * Reset any "file" sources to "default", else set_config_option
* will not override those settings. tentative_source should * will not override those settings.
* never be "file".
*/ */
if (gconf->reset_source == PGC_S_FILE) if (gconf->reset_source == PGC_S_FILE)
gconf->reset_source = PGC_S_DEFAULT; gconf->reset_source = PGC_S_DEFAULT;
Assert(gconf->tentative_source != PGC_S_FILE);
if (gconf->source == PGC_S_FILE) if (gconf->source == PGC_S_FILE)
gconf->source = PGC_S_DEFAULT; gconf->source = PGC_S_DEFAULT;
for (stack = gconf->stack; stack; stack = stack->prev) for (stack = gconf->stack; stack; stack = stack->prev)
{ {
Assert(stack->tentative_source != PGC_S_FILE);
if (stack->source == PGC_S_FILE) if (stack->source == PGC_S_FILE)
stack->source = PGC_S_DEFAULT; stack->source = PGC_S_DEFAULT;
} }
/* Now we can re-apply the wired-in default */ /* Now we can re-apply the wired-in default */
set_config_option(gconf->name, NULL, context, PGC_S_DEFAULT, set_config_option(gconf->name, NULL, context, PGC_S_DEFAULT,
false, true); GUC_ACTION_SET, true);
} }
/* /*
...@@ -289,25 +286,27 @@ ProcessConfigFile(GucContext context) ...@@ -289,25 +286,27 @@ ProcessConfigFile(GucContext context)
* is a no-op except in the case where one of these had been in the * is a no-op except in the case where one of these had been in the
* config file and is now removed. PGC_S_ENV_VAR will override the * config file and is now removed. PGC_S_ENV_VAR will override the
* wired-in default we just applied, but cannot override any other source. * wired-in default we just applied, but cannot override any other source.
* PGPORT can be ignored, because it cannot be changed without restart. *
* Keep this list in sync with InitializeGUCOptions()! * Keep this list in sync with InitializeGUCOptions()!
* PGPORT can be ignored, because it cannot be changed without restart.
* We assume rlimit hasn't changed, either.
*/ */
envvar = getenv("PGDATESTYLE"); envvar = getenv("PGDATESTYLE");
if (envvar != NULL) if (envvar != NULL)
set_config_option("datestyle", envvar, PGC_POSTMASTER, set_config_option("datestyle", envvar, PGC_POSTMASTER,
PGC_S_ENV_VAR, false, true); PGC_S_ENV_VAR, GUC_ACTION_SET, true);
envvar = getenv("PGCLIENTENCODING"); envvar = getenv("PGCLIENTENCODING");
if (envvar != NULL) if (envvar != NULL)
set_config_option("client_encoding", envvar, PGC_POSTMASTER, set_config_option("client_encoding", envvar, PGC_POSTMASTER,
PGC_S_ENV_VAR, false, true); PGC_S_ENV_VAR, GUC_ACTION_SET, true);
/* If we got here all the options checked out okay, so apply them. */ /* If we got here all the options checked out okay, so apply them. */
for (item = head; item; item = item->next) for (item = head; item; item = item->next)
{ {
set_config_option(item->name, item->value, context, set_config_option(item->name, item->value, context,
PGC_S_FILE, false, true); PGC_S_FILE, GUC_ACTION_SET, true);
} }
cleanup_list: cleanup_list:
......
This diff is collapsed.
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
* Copyright (c) 2000-2007, PostgreSQL Global Development Group * Copyright (c) 2000-2007, PostgreSQL Global Development Group
* Written by Peter Eisentraut <peter_e@gmx.net>. * Written by Peter Eisentraut <peter_e@gmx.net>.
* *
* $PostgreSQL: pgsql/src/include/utils/guc.h,v 1.85 2007/09/03 18:46:30 tgl Exp $ * $PostgreSQL: pgsql/src/include/utils/guc.h,v 1.86 2007/09/11 00:06:42 tgl Exp $
*-------------------------------------------------------------------- *--------------------------------------------------------------------
*/ */
#ifndef GUC_H #ifndef GUC_H
...@@ -100,6 +100,14 @@ typedef bool (*GucRealAssignHook) (double newval, bool doit, GucSource source); ...@@ -100,6 +100,14 @@ typedef bool (*GucRealAssignHook) (double newval, bool doit, GucSource source);
typedef const char *(*GucShowHook) (void); typedef const char *(*GucShowHook) (void);
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 */
} GucAction;
#define GUC_QUALIFIER_SEPARATOR '.' #define GUC_QUALIFIER_SEPARATOR '.'
/* GUC vars that are actually declared in guc.c, rather than elsewhere */ /* GUC vars that are actually declared in guc.c, rather than elsewhere */
...@@ -196,7 +204,7 @@ extern void BeginReportingGUCOptions(void); ...@@ -196,7 +204,7 @@ extern void BeginReportingGUCOptions(void);
extern void ParseLongOption(const char *string, char **name, char **value); extern void ParseLongOption(const char *string, char **name, char **value);
extern bool set_config_option(const char *name, const char *value, extern bool set_config_option(const char *name, const char *value,
GucContext context, GucSource source, GucContext context, GucSource source,
bool isLocal, bool changeVal); GucAction action, bool changeVal);
extern char *GetConfigOptionByName(const char *name, const char **varname); extern char *GetConfigOptionByName(const char *name, const char **varname);
extern void GetConfigOptionByNum(int varnum, const char **values, bool *noshow); extern void GetConfigOptionByNum(int varnum, const char **values, bool *noshow);
extern int GetNumConfigOptions(void); extern int GetNumConfigOptions(void);
...@@ -209,7 +217,7 @@ extern void ExecSetVariableStmt(VariableSetStmt *stmt); ...@@ -209,7 +217,7 @@ extern void ExecSetVariableStmt(VariableSetStmt *stmt);
extern char *ExtractSetVariableArgs(VariableSetStmt *stmt); extern char *ExtractSetVariableArgs(VariableSetStmt *stmt);
extern void ProcessGUCArray(ArrayType *array, extern void ProcessGUCArray(ArrayType *array,
GucContext context, GucSource source, bool isLocal); GucContext context, GucSource source, GucAction action);
extern ArrayType *GUCArrayAdd(ArrayType *array, const char *name, const char *value); extern ArrayType *GUCArrayAdd(ArrayType *array, const char *name, const char *value);
extern ArrayType *GUCArrayDelete(ArrayType *array, const char *name); extern ArrayType *GUCArrayDelete(ArrayType *array, const char *name);
......
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
* *
* Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
* *
* $PostgreSQL: pgsql/src/include/utils/guc_tables.h,v 1.34 2007/09/10 00:57:22 tgl Exp $ * $PostgreSQL: pgsql/src/include/utils/guc_tables.h,v 1.35 2007/09/11 00:06:42 tgl Exp $
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
*/ */
...@@ -79,18 +79,27 @@ enum config_group ...@@ -79,18 +79,27 @@ enum config_group
}; };
/* /*
* Stack entry for saving the state of a variable prior to the current * Stack entry for saving the state a variable had prior to an uncommitted
* transaction * transactional change
*/ */
typedef enum
{
/* This is almost GucAction, but we need a fourth state for SET+LOCAL */
GUC_SAVE, /* entry caused by function SET option */
GUC_SET, /* entry caused by plain SET command */
GUC_LOCAL, /* entry caused by SET LOCAL command */
GUC_SET_LOCAL /* entry caused by SET then SET LOCAL */
} GucStackState;
typedef struct guc_stack typedef struct guc_stack
{ {
struct guc_stack *prev; /* previous stack item, if any */ struct guc_stack *prev; /* previous stack item, if any */
int nest_level; /* nesting depth of cur transaction */ int nest_level; /* nesting depth at which we made entry */
int status; /* previous status bits, see below */ GucStackState state; /* see enum above */
GucSource tentative_source; /* source of the tentative_value */ GucSource source; /* source of the prior value */
GucSource source; /* source of the actual value */ union config_var_value prior; /* previous value of variable */
union config_var_value tentative_val; /* previous tentative val */ union config_var_value masked; /* SET value in a GUC_SET_LOCAL entry */
union config_var_value value; /* previous actual value */ /* masked value's source must be PGC_S_SESSION, so no need to store it */
} GucStack; } GucStack;
/* /*
...@@ -113,9 +122,8 @@ struct config_generic ...@@ -113,9 +122,8 @@ struct config_generic
enum config_type vartype; /* type of variable (set only at startup) */ enum config_type vartype; /* type of variable (set only at startup) */
int status; /* status bits, see below */ int status; /* status bits, see below */
GucSource reset_source; /* source of the reset_value */ GucSource reset_source; /* source of the reset_value */
GucSource tentative_source; /* source of the tentative_value */
GucSource source; /* source of the current actual value */ GucSource source; /* source of the current actual value */
GucStack *stack; /* stacked outside-of-transaction states */ GucStack *stack; /* stacked prior values */
}; };
/* bit values in flags field */ /* bit values in flags field */
...@@ -141,10 +149,7 @@ struct config_generic ...@@ -141,10 +149,7 @@ struct config_generic
#define GUC_UNIT_TIME 0x7000 /* mask for MS, S, MIN */ #define GUC_UNIT_TIME 0x7000 /* mask for MS, S, MIN */
/* bit values in status field */ /* bit values in status field */
#define GUC_HAVE_TENTATIVE 0x0001 /* tentative value is defined */ #define GUC_IS_IN_FILE 0x0001 /* found it in config file */
#define GUC_HAVE_LOCAL 0x0002 /* a SET LOCAL has been executed */
#define GUC_HAVE_STACK 0x0004 /* we have stacked prior value(s) */
#define GUC_IS_IN_FILE 0x0008 /* found it in config file */
/* /*
* Caution: the GUC_IS_IN_FILE bit is transient state for ProcessConfigFile. * Caution: the GUC_IS_IN_FILE bit is transient state for ProcessConfigFile.
* Do not assume that its value represents useful information elsewhere. * Do not assume that its value represents useful information elsewhere.
...@@ -163,7 +168,6 @@ struct config_bool ...@@ -163,7 +168,6 @@ struct config_bool
GucShowHook show_hook; GucShowHook show_hook;
/* variable fields, initialized at runtime: */ /* variable fields, initialized at runtime: */
bool reset_val; bool reset_val;
bool tentative_val;
}; };
struct config_int struct config_int
...@@ -178,7 +182,6 @@ struct config_int ...@@ -178,7 +182,6 @@ struct config_int
GucShowHook show_hook; GucShowHook show_hook;
/* variable fields, initialized at runtime: */ /* variable fields, initialized at runtime: */
int reset_val; int reset_val;
int tentative_val;
}; };
struct config_real struct config_real
...@@ -193,7 +196,6 @@ struct config_real ...@@ -193,7 +196,6 @@ struct config_real
GucShowHook show_hook; GucShowHook show_hook;
/* variable fields, initialized at runtime: */ /* variable fields, initialized at runtime: */
double reset_val; double reset_val;
double tentative_val;
}; };
struct config_string struct config_string
...@@ -206,7 +208,6 @@ struct config_string ...@@ -206,7 +208,6 @@ struct config_string
GucShowHook show_hook; GucShowHook show_hook;
/* variable fields, initialized at runtime: */ /* variable fields, initialized at runtime: */
char *reset_val; char *reset_val;
char *tentative_val;
}; };
/* constant tables corresponding to enums above and in guc.h */ /* constant tables corresponding to enums above and in guc.h */
......
...@@ -352,6 +352,85 @@ SELECT '2006-08-13 12:34:56'::timestamptz; ...@@ -352,6 +352,85 @@ SELECT '2006-08-13 12:34:56'::timestamptz;
2006-08-13 12:34:56-07 2006-08-13 12:34:56-07
(1 row) (1 row)
-- SET LOCAL persists through RELEASE (which was not true in 8.0-8.2)
BEGIN;
SHOW vacuum_cost_delay;
vacuum_cost_delay
-------------------
400ms
(1 row)
SHOW datestyle;
DateStyle
-----------
ISO, YMD
(1 row)
SELECT '2006-08-13 12:34:56'::timestamptz;
timestamptz
------------------------
2006-08-13 12:34:56-07
(1 row)
SAVEPOINT sp;
SET LOCAL vacuum_cost_delay TO 300;
SHOW vacuum_cost_delay;
vacuum_cost_delay
-------------------
300ms
(1 row)
SET LOCAL datestyle = 'Postgres, MDY';
SHOW datestyle;
DateStyle
---------------
Postgres, MDY
(1 row)
SELECT '2006-08-13 12:34:56'::timestamptz;
timestamptz
------------------------------
Sun Aug 13 12:34:56 2006 PDT
(1 row)
RELEASE SAVEPOINT sp;
SHOW vacuum_cost_delay;
vacuum_cost_delay
-------------------
300ms
(1 row)
SHOW datestyle;
DateStyle
---------------
Postgres, MDY
(1 row)
SELECT '2006-08-13 12:34:56'::timestamptz;
timestamptz
------------------------------
Sun Aug 13 12:34:56 2006 PDT
(1 row)
ROLLBACK;
SHOW vacuum_cost_delay;
vacuum_cost_delay
-------------------
400ms
(1 row)
SHOW datestyle;
DateStyle
-----------
ISO, YMD
(1 row)
SELECT '2006-08-13 12:34:56'::timestamptz;
timestamptz
------------------------
2006-08-13 12:34:56-07
(1 row)
-- SET followed by SET LOCAL -- SET followed by SET LOCAL
BEGIN; BEGIN;
SET vacuum_cost_delay TO 400; SET vacuum_cost_delay TO 400;
...@@ -558,3 +637,65 @@ select report_guc('regex_flavor'), current_setting('regex_flavor'); ...@@ -558,3 +637,65 @@ select report_guc('regex_flavor'), current_setting('regex_flavor');
advanced | advanced advanced | advanced
(1 row) (1 row)
-- SET LOCAL is restricted by a function SET option
create or replace function myfunc(int) returns text as $$
begin
set local regex_flavor = extended;
return current_setting('regex_flavor');
end $$
language plpgsql
set regex_flavor = basic;
select myfunc(0), current_setting('regex_flavor');
myfunc | current_setting
----------+-----------------
extended | advanced
(1 row)
alter function myfunc(int) reset all;
select myfunc(0), current_setting('regex_flavor');
myfunc | current_setting
----------+-----------------
extended | extended
(1 row)
set regex_flavor = advanced;
-- but SET isn't
create or replace function myfunc(int) returns text as $$
begin
set regex_flavor = extended;
return current_setting('regex_flavor');
end $$
language plpgsql
set regex_flavor = basic;
select myfunc(0), current_setting('regex_flavor');
myfunc | current_setting
----------+-----------------
extended | extended
(1 row)
set regex_flavor = advanced;
-- it should roll back on error, though
create or replace function myfunc(int) returns text as $$
begin
set regex_flavor = extended;
perform 1/$1;
return current_setting('regex_flavor');
end $$
language plpgsql
set regex_flavor = basic;
select myfunc(0);
ERROR: division by zero
CONTEXT: SQL statement "SELECT 1/ $1 "
PL/pgSQL function "myfunc" line 3 at PERFORM
select current_setting('regex_flavor');
current_setting
-----------------
advanced
(1 row)
select myfunc(1), current_setting('regex_flavor');
myfunc | current_setting
----------+-----------------
extended | extended
(1 row)
...@@ -99,6 +99,26 @@ SHOW vacuum_cost_delay; ...@@ -99,6 +99,26 @@ SHOW vacuum_cost_delay;
SHOW datestyle; SHOW datestyle;
SELECT '2006-08-13 12:34:56'::timestamptz; SELECT '2006-08-13 12:34:56'::timestamptz;
-- SET LOCAL persists through RELEASE (which was not true in 8.0-8.2)
BEGIN;
SHOW vacuum_cost_delay;
SHOW datestyle;
SELECT '2006-08-13 12:34:56'::timestamptz;
SAVEPOINT sp;
SET LOCAL vacuum_cost_delay TO 300;
SHOW vacuum_cost_delay;
SET LOCAL datestyle = 'Postgres, MDY';
SHOW datestyle;
SELECT '2006-08-13 12:34:56'::timestamptz;
RELEASE SAVEPOINT sp;
SHOW vacuum_cost_delay;
SHOW datestyle;
SELECT '2006-08-13 12:34:56'::timestamptz;
ROLLBACK;
SHOW vacuum_cost_delay;
SHOW datestyle;
SELECT '2006-08-13 12:34:56'::timestamptz;
-- SET followed by SET LOCAL -- SET followed by SET LOCAL
BEGIN; BEGIN;
SET vacuum_cost_delay TO 400; SET vacuum_cost_delay TO 400;
...@@ -187,3 +207,47 @@ select report_guc('regex_flavor'), current_setting('regex_flavor'); ...@@ -187,3 +207,47 @@ select report_guc('regex_flavor'), current_setting('regex_flavor');
alter function report_guc(text) reset all; alter function report_guc(text) reset all;
select report_guc('regex_flavor'), current_setting('regex_flavor'); select report_guc('regex_flavor'), current_setting('regex_flavor');
-- SET LOCAL is restricted by a function SET option
create or replace function myfunc(int) returns text as $$
begin
set local regex_flavor = extended;
return current_setting('regex_flavor');
end $$
language plpgsql
set regex_flavor = basic;
select myfunc(0), current_setting('regex_flavor');
alter function myfunc(int) reset all;
select myfunc(0), current_setting('regex_flavor');
set regex_flavor = advanced;
-- but SET isn't
create or replace function myfunc(int) returns text as $$
begin
set regex_flavor = extended;
return current_setting('regex_flavor');
end $$
language plpgsql
set regex_flavor = basic;
select myfunc(0), current_setting('regex_flavor');
set regex_flavor = advanced;
-- it should roll back on error, though
create or replace function myfunc(int) returns text as $$
begin
set regex_flavor = extended;
perform 1/$1;
return current_setting('regex_flavor');
end $$
language plpgsql
set regex_flavor = basic;
select myfunc(0);
select current_setting('regex_flavor');
select myfunc(1), current_setting('regex_flavor');
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment