public inbox for [email protected]help / color / mirror / Atom feed
Re: Introduce XID age and inactive timeout based replication slot invalidation 43+ messages / 7 participants [nested] [flat]
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-21 17:51 Bharath Rupireddy <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-21 17:51 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Thu, Mar 21, 2024 at 4:25 PM Amit Kapila <[email protected]> wrote: > > This makes sense to me. Apart from this, few more comments on 0001. Thanks for looking into it. > 1. > - "%s as caught_up, conflict_reason IS NOT NULL as invalid " > + "%s as caught_up, invalidation_reason IS NOT NULL as invalid " > live_check ? "FALSE" : > - "(CASE WHEN conflict_reason IS NOT NULL THEN FALSE " > + "(CASE WHEN conflicting THEN FALSE " > > I think here at both places we need to change 'conflict_reason' to > 'conflicting'. Basically, the idea there is to not live_check for invalidated logical slots. It has nothing to do with conflicting. Up until now, conflict_reason is also reporting wal_removed (although wrongly including rows_removed, wal_level_insufficient, the two reasons for conflicts). So, I think invalidation_reason is right for invalid column. Also, I think we need to change conflicting to invalidation_reason for live_check. So, I've changed that to use invalidation_reason for both columns. > 2. > > Can the reasons 'rows_removed' and 'wal_level_insufficient' appear for > physical slots? No. They can only occur for logical slots, check InvalidatePossiblyObsoleteSlot, only the logical slots get invalidated. > If not, then it is not clear from above text. I've stated that "It is set only for logical slots." for rows_removed and wal_level_insufficient. Other reasons can occur for both slots. > 3. > -# Verify slots are reported as non conflicting in pg_replication_slots > +# Verify slots are reported as valid in pg_replication_slots > is( $node_standby->safe_psql( > 'postgres', > q[select bool_or(conflicting) from > - (select conflict_reason is not NULL as conflicting > - from pg_replication_slots WHERE slot_type = 'logical')]), > + (select conflicting from pg_replication_slots > + where slot_type = 'logical')]), > 'f', > - 'Logical slots are reported as non conflicting'); > + 'Logical slots are reported as valid'); > > I don't think we need to change the comment or success message in this test. Yes. There the intention of the test case is to verify logical slots are reported as non conflicting. So, I changed them. Please find the v14-0001 patch for now. I'll post the other patches soon. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/octet-stream] v14-0001-Track-invalidation_reason-in-pg_replication_slot.patch (24.3K, ../../CALj2ACVKncd+JZR8BeXSgPO4akqic9kO99Z6pCfeXQKwmye2Og@mail.gmail.com/2-v14-0001-Track-invalidation_reason-in-pg_replication_slot.patch) download | inline diff: From 606c2f61f11c1a57fbc3c9ffd6d553f6f6b47473 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Thu, 21 Mar 2024 17:43:50 +0000 Subject: [PATCH v14] Track invalidation_reason in pg_replication_slots Up until now, reason for replication slot invalidation is not tracked in pg_replication_slots. A recent commit 007693f2a added 'conflict_reason' to show the reasons for slot invalidation, but only for logical slots. This commit adds a new column 'invalidation_reason' to show invalidation reasons for both physical and logical slots. And, this commit also turns 'conflict_reason' text column to 'conflicting' boolean column (effectively reverting commit 007693f2a). The 'conflicting' column is true for inavlidation reasons 'rows_removed' and 'wal_level_insufficient', because they are the ones making the slot conflict with recovery. When 'conflicting' is true, one can now look at the new 'invalidation_reason' column for reason for logical slots conflict with recovery. The new 'invalidation_reason' column will also be useful when we add more invalidation reasons in the future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Reviewed-by: shveta malik Discussion: https://www.postgresql.org/message-id/ZfR7HuzFEswakt/a%40ip-10-97-1-34.eu-west-3.compute.internal --- doc/src/sgml/ref/pgupgrade.sgml | 4 +- doc/src/sgml/system-views.sgml | 25 +++++++--- src/backend/catalog/system_views.sql | 3 +- src/backend/replication/logical/slotsync.c | 2 +- src/backend/replication/slot.c | 49 +++++++++---------- src/backend/replication/slotfuncs.c | 25 +++++++--- src/bin/pg_upgrade/info.c | 4 +- src/include/catalog/pg_proc.dat | 6 +-- src/include/replication/slot.h | 2 +- .../t/035_standby_logical_decoding.pl | 35 ++++++------- .../t/040_standby_failover_slots_sync.pl | 4 +- src/test/regress/expected/rules.out | 5 +- 12 files changed, 93 insertions(+), 71 deletions(-) diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml index 58c6c2df8b..8de52bf752 100644 --- a/doc/src/sgml/ref/pgupgrade.sgml +++ b/doc/src/sgml/ref/pgupgrade.sgml @@ -453,8 +453,8 @@ make prefix=/usr/local/pgsql.new install <para> All slots on the old cluster must be usable, i.e., there are no slots whose - <link linkend="view-pg-replication-slots">pg_replication_slots</link>.<structfield>conflict_reason</structfield> - is not <literal>NULL</literal>. + <link linkend="view-pg-replication-slots">pg_replication_slots</link>.<structfield>conflicting</structfield> + is not <literal>true</literal>. </para> </listitem> <listitem> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index be90edd0e2..b5da476c20 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2525,13 +2525,24 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <row> <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>conflict_reason</structfield> <type>text</type> + <structfield>conflicting</structfield> <type>bool</type> </para> <para> - The reason for the logical slot's conflict with recovery. It is always - NULL for physical slots, as well as for logical slots which are not - invalidated. The non-NULL values indicate that the slot is marked - as invalidated. Possible values are: + True if this logical slot conflicted with recovery (and so is now + invalidated). When this column is true, check + <structfield>invalidation_reason</structfield> column for the conflict + reason. Always NULL for physical slots. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>invalidation_reason</structfield> <type>text</type> + </para> + <para> + The reason for the slot's invalidation. It is set for both logical and + physical slots. <literal>NULL</literal> if the slot is not invalidated. + Possible values are: <itemizedlist spacing="compact"> <listitem> <para> @@ -2542,14 +2553,14 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <listitem> <para> <literal>rows_removed</literal> means that the required rows have - been removed. + been removed. It is set only for logical slots. </para> </listitem> <listitem> <para> <literal>wal_level_insufficient</literal> means that the primary doesn't have a <xref linkend="guc-wal-level"/> sufficient to - perform logical decoding. + perform logical decoding. It is set only for logical slots. </para> </listitem> </itemizedlist> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index 04227a72d1..f69b7f5580 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,7 +1023,8 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, - L.conflict_reason, + L.conflicting, + L.invalidation_reason, L.failover, L.synced FROM pg_get_replication_slots() AS L diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index 7b180bdb5c..30480960c5 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -663,7 +663,7 @@ synchronize_slots(WalReceiverConn *wrconn) bool started_tx = false; const char *query = "SELECT slot_name, plugin, confirmed_flush_lsn," " restart_lsn, catalog_xmin, two_phase, failover," - " database, conflict_reason" + " database, invalidation_reason" " FROM pg_catalog.pg_replication_slots" " WHERE failover and NOT temporary"; diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 91ca397857..cdf0c450c5 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -1525,14 +1525,14 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, XLogRecPtr initial_effective_xmin = InvalidXLogRecPtr; XLogRecPtr initial_catalog_effective_xmin = InvalidXLogRecPtr; XLogRecPtr initial_restart_lsn = InvalidXLogRecPtr; - ReplicationSlotInvalidationCause conflict_prev PG_USED_FOR_ASSERTS_ONLY = RS_INVAL_NONE; + ReplicationSlotInvalidationCause invalidation_cause_prev PG_USED_FOR_ASSERTS_ONLY = RS_INVAL_NONE; for (;;) { XLogRecPtr restart_lsn; NameData slotname; int active_pid = 0; - ReplicationSlotInvalidationCause conflict = RS_INVAL_NONE; + ReplicationSlotInvalidationCause invalidation_cause = RS_INVAL_NONE; Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); @@ -1554,17 +1554,14 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, restart_lsn = s->data.restart_lsn; - /* - * If the slot is already invalid or is a non conflicting slot, we - * don't need to do anything. - */ + /* we do nothing if the slot is already invalid */ if (s->data.invalidated == RS_INVAL_NONE) { /* * The slot's mutex will be released soon, and it is possible that * those values change since the process holding the slot has been * terminated (if any), so record them here to ensure that we - * would report the correct conflict cause. + * would report the correct invalidation cause. */ if (!terminated) { @@ -1578,7 +1575,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, case RS_INVAL_WAL_REMOVED: if (initial_restart_lsn != InvalidXLogRecPtr && initial_restart_lsn < oldestLSN) - conflict = cause; + invalidation_cause = cause; break; case RS_INVAL_HORIZON: if (!SlotIsLogical(s)) @@ -1589,15 +1586,15 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, if (TransactionIdIsValid(initial_effective_xmin) && TransactionIdPrecedesOrEquals(initial_effective_xmin, snapshotConflictHorizon)) - conflict = cause; + invalidation_cause = cause; else if (TransactionIdIsValid(initial_catalog_effective_xmin) && TransactionIdPrecedesOrEquals(initial_catalog_effective_xmin, snapshotConflictHorizon)) - conflict = cause; + invalidation_cause = cause; break; case RS_INVAL_WAL_LEVEL: if (SlotIsLogical(s)) - conflict = cause; + invalidation_cause = cause; break; case RS_INVAL_NONE: pg_unreachable(); @@ -1605,14 +1602,14 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, } /* - * The conflict cause recorded previously should not change while the - * process owning the slot (if any) has been terminated. + * The invalidation cause recorded previously should not change while + * the process owning the slot (if any) has been terminated. */ - Assert(!(conflict_prev != RS_INVAL_NONE && terminated && - conflict_prev != conflict)); + Assert(!(invalidation_cause_prev != RS_INVAL_NONE && terminated && + invalidation_cause_prev != invalidation_cause)); - /* if there's no conflict, we're done */ - if (conflict == RS_INVAL_NONE) + /* if there's no invalidation, we're done */ + if (invalidation_cause == RS_INVAL_NONE) { SpinLockRelease(&s->mutex); if (released_lock) @@ -1632,13 +1629,13 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, { MyReplicationSlot = s; s->active_pid = MyProcPid; - s->data.invalidated = conflict; + s->data.invalidated = invalidation_cause; /* * XXX: We should consider not overwriting restart_lsn and instead * just rely on .invalidated. */ - if (conflict == RS_INVAL_WAL_REMOVED) + if (invalidation_cause == RS_INVAL_WAL_REMOVED) s->data.restart_lsn = InvalidXLogRecPtr; /* Let caller know */ @@ -1681,7 +1678,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, */ if (last_signaled_pid != active_pid) { - ReportSlotInvalidation(conflict, true, active_pid, + ReportSlotInvalidation(invalidation_cause, true, active_pid, slotname, restart_lsn, oldestLSN, snapshotConflictHorizon); @@ -1694,7 +1691,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, last_signaled_pid = active_pid; terminated = true; - conflict_prev = conflict; + invalidation_cause_prev = invalidation_cause; } /* Wait until the slot is released. */ @@ -1727,7 +1724,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, ReplicationSlotSave(); ReplicationSlotRelease(); - ReportSlotInvalidation(conflict, false, active_pid, + ReportSlotInvalidation(invalidation_cause, false, active_pid, slotname, restart_lsn, oldestLSN, snapshotConflictHorizon); @@ -2356,21 +2353,21 @@ RestoreSlotFromDisk(const char *name) } /* - * Maps a conflict reason for a replication slot to + * Maps an invalidation reason for a replication slot to * ReplicationSlotInvalidationCause. */ ReplicationSlotInvalidationCause -GetSlotInvalidationCause(const char *conflict_reason) +GetSlotInvalidationCause(const char *invalidation_reason) { ReplicationSlotInvalidationCause cause; ReplicationSlotInvalidationCause result = RS_INVAL_NONE; bool found PG_USED_FOR_ASSERTS_ONLY = false; - Assert(conflict_reason); + Assert(invalidation_reason); for (cause = RS_INVAL_NONE; cause <= RS_INVAL_MAX_CAUSES; cause++) { - if (strcmp(SlotInvalidationCauses[cause], conflict_reason) == 0) + if (strcmp(SlotInvalidationCauses[cause], invalidation_reason) == 0) { found = true; result = cause; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index ad79e1fccd..4232c1e52e 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 17 +#define PG_GET_REPLICATION_SLOTS_COLS 18 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -263,6 +263,7 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) bool nulls[PG_GET_REPLICATION_SLOTS_COLS]; WALAvailability walstate; int i; + ReplicationSlotInvalidationCause cause; if (!slot->in_use) continue; @@ -409,18 +410,28 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); - if (slot_contents.data.database == InvalidOid) + cause = slot_contents.data.invalidated; + + if (SlotIsPhysical(&slot_contents)) nulls[i++] = true; else { - ReplicationSlotInvalidationCause cause = slot_contents.data.invalidated; - - if (cause == RS_INVAL_NONE) - nulls[i++] = true; + /* + * rows_removed and wal_level_insufficient are the only two + * reasons for the logical slot's conflict with recovery. + */ + if (cause == RS_INVAL_HORIZON || + cause == RS_INVAL_WAL_LEVEL) + values[i++] = BoolGetDatum(true); else - values[i++] = CStringGetTextDatum(SlotInvalidationCauses[cause]); + values[i++] = BoolGetDatum(false); } + if (cause == RS_INVAL_NONE) + nulls[i++] = true; + else + values[i++] = CStringGetTextDatum(SlotInvalidationCauses[cause]); + values[i++] = BoolGetDatum(slot_contents.data.failover); values[i++] = BoolGetDatum(slot_contents.data.synced); diff --git a/src/bin/pg_upgrade/info.c b/src/bin/pg_upgrade/info.c index b5b8d11602..95c22a7200 100644 --- a/src/bin/pg_upgrade/info.c +++ b/src/bin/pg_upgrade/info.c @@ -676,13 +676,13 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) * removed. */ res = executeQueryOrDie(conn, "SELECT slot_name, plugin, two_phase, failover, " - "%s as caught_up, conflict_reason IS NOT NULL as invalid " + "%s as caught_up, invalidation_reason IS NOT NULL as invalid " "FROM pg_catalog.pg_replication_slots " "WHERE slot_type = 'logical' AND " "database = current_database() AND " "temporary IS FALSE;", live_check ? "FALSE" : - "(CASE WHEN conflict_reason IS NOT NULL THEN FALSE " + "(CASE WHEN invalidation_reason IS NOT NULL THEN FALSE " "ELSE (SELECT pg_catalog.binary_upgrade_logical_slot_has_caught_up(slot_name)) " "END)"); diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 042f66f714..71c74350a0 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflict_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 425effad21..7f25a083ee 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -273,7 +273,7 @@ extern void CheckPointReplicationSlots(bool is_shutdown); extern void CheckSlotRequirements(void); extern void CheckSlotPermissions(void); extern ReplicationSlotInvalidationCause - GetSlotInvalidationCause(const char *conflict_reason); + GetSlotInvalidationCause(const char *invalidation_reason); extern bool SlotExistsInStandbySlotNames(const char *slot_name); extern bool StandbySlotsHaveCaughtup(XLogRecPtr wait_for_lsn, int elevel); diff --git a/src/test/recovery/t/035_standby_logical_decoding.pl b/src/test/recovery/t/035_standby_logical_decoding.pl index 88b03048c4..8d6740c734 100644 --- a/src/test/recovery/t/035_standby_logical_decoding.pl +++ b/src/test/recovery/t/035_standby_logical_decoding.pl @@ -168,7 +168,7 @@ sub change_hot_standby_feedback_and_wait_for_xmins } } -# Check conflict_reason in pg_replication_slots. +# Check reason for conflict in pg_replication_slots. sub check_slots_conflict_reason { my ($slot_prefix, $reason) = @_; @@ -178,15 +178,15 @@ sub check_slots_conflict_reason $res = $node_standby->safe_psql( 'postgres', qq( - select conflict_reason from pg_replication_slots where slot_name = '$active_slot';)); + select invalidation_reason from pg_replication_slots where slot_name = '$active_slot' and conflicting;)); - is($res, "$reason", "$active_slot conflict_reason is $reason"); + is($res, "$reason", "$active_slot reason for conflict is $reason"); $res = $node_standby->safe_psql( 'postgres', qq( - select conflict_reason from pg_replication_slots where slot_name = '$inactive_slot';)); + select invalidation_reason from pg_replication_slots where slot_name = '$inactive_slot' and conflicting;)); - is($res, "$reason", "$inactive_slot conflict_reason is $reason"); + is($res, "$reason", "$inactive_slot reason for conflict is $reason"); } # Drop the slots, re-create them, change hot_standby_feedback, @@ -293,13 +293,13 @@ $node_primary->safe_psql('testdb', qq[SELECT * FROM pg_create_physical_replication_slot('$primary_slotname');] ); -# Check conflict_reason is NULL for physical slot +# Check conflicting is NULL for physical slot $res = $node_primary->safe_psql( 'postgres', qq[ - SELECT conflict_reason is null FROM pg_replication_slots where slot_name = '$primary_slotname';] + SELECT conflicting is null FROM pg_replication_slots where slot_name = '$primary_slotname';] ); -is($res, 't', "Physical slot reports conflict_reason as NULL"); +is($res, 't', "Physical slot reports conflicting as NULL"); my $backup_name = 'b1'; $node_primary->backup($backup_name); @@ -524,7 +524,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('vacuum_full_', 1, 'with vacuum FULL on pg_class'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('vacuum_full_', 'rows_removed'); # Ensure that replication slot stats are not removed after invalidation. @@ -551,7 +551,7 @@ change_hot_standby_feedback_and_wait_for_xmins(1, 1); ################################################## $node_standby->restart; -# Verify conflict_reason is retained across a restart. +# Verify reason for conflict is retained across a restart. check_slots_conflict_reason('vacuum_full_', 'rows_removed'); ################################################## @@ -560,7 +560,8 @@ check_slots_conflict_reason('vacuum_full_', 'rows_removed'); # Get the restart_lsn from an invalidated slot my $restart_lsn = $node_standby->safe_psql('postgres', - "SELECT restart_lsn from pg_replication_slots WHERE slot_name = 'vacuum_full_activeslot' and conflict_reason is not null;" + "SELECT restart_lsn FROM pg_replication_slots + WHERE slot_name = 'vacuum_full_activeslot' AND conflicting;" ); chomp($restart_lsn); @@ -611,7 +612,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('row_removal_', $logstart, 'with vacuum on pg_class'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('row_removal_', 'rows_removed'); $handle = @@ -647,7 +648,7 @@ $node_primary->wait_for_replay_catchup($node_standby); check_for_invalidation('shared_row_removal_', $logstart, 'with vacuum on pg_authid'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('shared_row_removal_', 'rows_removed'); $handle = make_slot_active($node_standby, 'shared_row_removal_', 0, \$stdout, @@ -700,8 +701,8 @@ ok( $node_standby->poll_query_until( is( $node_standby->safe_psql( 'postgres', q[select bool_or(conflicting) from - (select conflict_reason is not NULL as conflicting - from pg_replication_slots WHERE slot_type = 'logical')]), + (select conflicting from pg_replication_slots + where slot_type = 'logical')]), 'f', 'Logical slots are reported as non conflicting'); @@ -739,7 +740,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('pruning_', $logstart, 'with on-access pruning'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('pruning_', 'rows_removed'); $handle = make_slot_active($node_standby, 'pruning_', 0, \$stdout, \$stderr); @@ -783,7 +784,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('wal_level_', $logstart, 'due to wal_level'); -# Verify conflict_reason is 'wal_level_insufficient' in pg_replication_slots +# Verify reason for conflict is 'wal_level_insufficient' in pg_replication_slots check_slots_conflict_reason('wal_level_', 'wal_level_insufficient'); $handle = diff --git a/src/test/recovery/t/040_standby_failover_slots_sync.pl b/src/test/recovery/t/040_standby_failover_slots_sync.pl index 0ea1f3d323..f47bfd78eb 100644 --- a/src/test/recovery/t/040_standby_failover_slots_sync.pl +++ b/src/test/recovery/t/040_standby_failover_slots_sync.pl @@ -228,7 +228,7 @@ $standby1->safe_psql('postgres', "CHECKPOINT"); # Check if the synced slot is invalidated is( $standby1->safe_psql( 'postgres', - q{SELECT conflict_reason = 'wal_removed' FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} + q{SELECT invalidation_reason = 'wal_removed' FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} ), "t", 'synchronized slot has been invalidated'); @@ -274,7 +274,7 @@ $standby1->wait_for_log(qr/dropped replication slot "lsub1_slot" of dbid [0-9]+/ # flagged as 'synced' is( $standby1->safe_psql( 'postgres', - q{SELECT conflict_reason IS NULL AND synced AND NOT temporary FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} + q{SELECT invalidation_reason IS NULL AND synced AND NOT temporary FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} ), "t", 'logical slot is re-synced'); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 84e359f6ed..18829ea586 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,10 +1473,11 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, - l.conflict_reason, + l.conflicting, + l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflict_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 05:19 Amit Kapila <[email protected]> parent: Bharath Rupireddy <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-22 05:19 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Thu, Mar 21, 2024 at 11:21 PM Bharath Rupireddy <[email protected]> wrote: > > > Please find the v14-0001 patch for now. I'll post the other patches soon. > LGTM. Let's wait for Bertrand to see if he has more comments on 0001 and then I'll push it. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 07:09 Bertrand Drouvot <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-22 07:09 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Fri, Mar 22, 2024 at 10:49:17AM +0530, Amit Kapila wrote: > On Thu, Mar 21, 2024 at 11:21 PM Bharath Rupireddy > <[email protected]> wrote: > > > > > > Please find the v14-0001 patch for now. Thanks! > LGTM. Let's wait for Bertrand to see if he has more comments on 0001 > and then I'll push it. LGTM too. Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 08:15 Bharath Rupireddy <[email protected]> parent: Bertrand Drouvot <[email protected]> 0 siblings, 3 replies; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-22 08:15 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 12:39 PM Bertrand Drouvot <[email protected]> wrote: > > > > Please find the v14-0001 patch for now. > > Thanks! > > > LGTM. Let's wait for Bertrand to see if he has more comments on 0001 > > and then I'll push it. > > LGTM too. Thanks. Here I'm implementing the following: 0001 Track invalidation_reason in pg_replication_slots 0002 Track last_inactive_at in pg_replication_slots 0003 Allow setting inactive_timeout for replication slots via SQL API 0004 Introduce new SQL funtion pg_alter_replication_slot 0005 Allow setting inactive_timeout in the replication command 0006 Add inactive_timeout based replication slot invalidation 1. Keep it last_inactive_at as a shared memory variable, but always set it at restart if the slot's inactive_timeout has non-zero value and reset it as soon as someone acquires that slot so that if the slot doesn't get acquired till inactive_timeout, checkpointer will invalidate the slot. 2. Ensure with pg_alter_replication_slot one could "only" alter the timeout property for the time being, if not that could lead to the subscription inconsistency. 3. Have some notes in the CREATE and ALTER SUBSCRIPTION docs about using an existing slot to leverage inactive_timeout feature. 4. last_inactive_at should also be set to the current time during slot creation because if one creates a slot and does nothing with it then it's the time it starts to be inactive. 5. We don't set last_inactive_at to GetCurrentTimestamp() for failover slots. 6. Leave the patch that added support for inactive_timeout in subscriptions. Please see the attached v14 patch set. No change in the attached v14-0001 from the previous patch. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/x-patch] v14-0001-Track-invalidation_reason-in-pg_replication_slot.patch (24.3K, ../../CALj2ACWuNHJ3qBMmmy6i1YA9V8JDRSaciL2bBM+72bRcqiBE2g@mail.gmail.com/2-v14-0001-Track-invalidation_reason-in-pg_replication_slot.patch) download | inline diff: From 9ce64d4e6b629d70516bb2a16c5cbfa458c3a244 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Fri, 22 Mar 2024 02:56:12 +0000 Subject: [PATCH v14 1/6] Track invalidation_reason in pg_replication_slots Up until now, reason for replication slot invalidation is not tracked in pg_replication_slots. A recent commit 007693f2a added 'conflict_reason' to show the reasons for slot invalidation, but only for logical slots. This commit adds a new column 'invalidation_reason' to show invalidation reasons for both physical and logical slots. And, this commit also turns 'conflict_reason' text column to 'conflicting' boolean column (effectively reverting commit 007693f2a). The 'conflicting' column is true for inavlidation reasons 'rows_removed' and 'wal_level_insufficient', because they are the ones making the slot conflict with recovery. When 'conflicting' is true, one can now look at the new 'invalidation_reason' column for reason for logical slots conflict with recovery. The new 'invalidation_reason' column will also be useful when we add more invalidation reasons in the future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Reviewed-by: shveta malik Discussion: https://www.postgresql.org/message-id/ZfR7HuzFEswakt/a%40ip-10-97-1-34.eu-west-3.compute.internal --- doc/src/sgml/ref/pgupgrade.sgml | 4 +- doc/src/sgml/system-views.sgml | 25 +++++++--- src/backend/catalog/system_views.sql | 3 +- src/backend/replication/logical/slotsync.c | 2 +- src/backend/replication/slot.c | 49 +++++++++---------- src/backend/replication/slotfuncs.c | 25 +++++++--- src/bin/pg_upgrade/info.c | 4 +- src/include/catalog/pg_proc.dat | 6 +-- src/include/replication/slot.h | 2 +- .../t/035_standby_logical_decoding.pl | 35 ++++++------- .../t/040_standby_failover_slots_sync.pl | 4 +- src/test/regress/expected/rules.out | 5 +- 12 files changed, 93 insertions(+), 71 deletions(-) diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml index 58c6c2df8b..8de52bf752 100644 --- a/doc/src/sgml/ref/pgupgrade.sgml +++ b/doc/src/sgml/ref/pgupgrade.sgml @@ -453,8 +453,8 @@ make prefix=/usr/local/pgsql.new install <para> All slots on the old cluster must be usable, i.e., there are no slots whose - <link linkend="view-pg-replication-slots">pg_replication_slots</link>.<structfield>conflict_reason</structfield> - is not <literal>NULL</literal>. + <link linkend="view-pg-replication-slots">pg_replication_slots</link>.<structfield>conflicting</structfield> + is not <literal>true</literal>. </para> </listitem> <listitem> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index be90edd0e2..b5da476c20 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2525,13 +2525,24 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <row> <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>conflict_reason</structfield> <type>text</type> + <structfield>conflicting</structfield> <type>bool</type> </para> <para> - The reason for the logical slot's conflict with recovery. It is always - NULL for physical slots, as well as for logical slots which are not - invalidated. The non-NULL values indicate that the slot is marked - as invalidated. Possible values are: + True if this logical slot conflicted with recovery (and so is now + invalidated). When this column is true, check + <structfield>invalidation_reason</structfield> column for the conflict + reason. Always NULL for physical slots. + </para></entry> + </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>invalidation_reason</structfield> <type>text</type> + </para> + <para> + The reason for the slot's invalidation. It is set for both logical and + physical slots. <literal>NULL</literal> if the slot is not invalidated. + Possible values are: <itemizedlist spacing="compact"> <listitem> <para> @@ -2542,14 +2553,14 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <listitem> <para> <literal>rows_removed</literal> means that the required rows have - been removed. + been removed. It is set only for logical slots. </para> </listitem> <listitem> <para> <literal>wal_level_insufficient</literal> means that the primary doesn't have a <xref linkend="guc-wal-level"/> sufficient to - perform logical decoding. + perform logical decoding. It is set only for logical slots. </para> </listitem> </itemizedlist> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index 04227a72d1..f69b7f5580 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,7 +1023,8 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, - L.conflict_reason, + L.conflicting, + L.invalidation_reason, L.failover, L.synced FROM pg_get_replication_slots() AS L diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index 7b180bdb5c..30480960c5 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -663,7 +663,7 @@ synchronize_slots(WalReceiverConn *wrconn) bool started_tx = false; const char *query = "SELECT slot_name, plugin, confirmed_flush_lsn," " restart_lsn, catalog_xmin, two_phase, failover," - " database, conflict_reason" + " database, invalidation_reason" " FROM pg_catalog.pg_replication_slots" " WHERE failover and NOT temporary"; diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 91ca397857..cdf0c450c5 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -1525,14 +1525,14 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, XLogRecPtr initial_effective_xmin = InvalidXLogRecPtr; XLogRecPtr initial_catalog_effective_xmin = InvalidXLogRecPtr; XLogRecPtr initial_restart_lsn = InvalidXLogRecPtr; - ReplicationSlotInvalidationCause conflict_prev PG_USED_FOR_ASSERTS_ONLY = RS_INVAL_NONE; + ReplicationSlotInvalidationCause invalidation_cause_prev PG_USED_FOR_ASSERTS_ONLY = RS_INVAL_NONE; for (;;) { XLogRecPtr restart_lsn; NameData slotname; int active_pid = 0; - ReplicationSlotInvalidationCause conflict = RS_INVAL_NONE; + ReplicationSlotInvalidationCause invalidation_cause = RS_INVAL_NONE; Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); @@ -1554,17 +1554,14 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, restart_lsn = s->data.restart_lsn; - /* - * If the slot is already invalid or is a non conflicting slot, we - * don't need to do anything. - */ + /* we do nothing if the slot is already invalid */ if (s->data.invalidated == RS_INVAL_NONE) { /* * The slot's mutex will be released soon, and it is possible that * those values change since the process holding the slot has been * terminated (if any), so record them here to ensure that we - * would report the correct conflict cause. + * would report the correct invalidation cause. */ if (!terminated) { @@ -1578,7 +1575,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, case RS_INVAL_WAL_REMOVED: if (initial_restart_lsn != InvalidXLogRecPtr && initial_restart_lsn < oldestLSN) - conflict = cause; + invalidation_cause = cause; break; case RS_INVAL_HORIZON: if (!SlotIsLogical(s)) @@ -1589,15 +1586,15 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, if (TransactionIdIsValid(initial_effective_xmin) && TransactionIdPrecedesOrEquals(initial_effective_xmin, snapshotConflictHorizon)) - conflict = cause; + invalidation_cause = cause; else if (TransactionIdIsValid(initial_catalog_effective_xmin) && TransactionIdPrecedesOrEquals(initial_catalog_effective_xmin, snapshotConflictHorizon)) - conflict = cause; + invalidation_cause = cause; break; case RS_INVAL_WAL_LEVEL: if (SlotIsLogical(s)) - conflict = cause; + invalidation_cause = cause; break; case RS_INVAL_NONE: pg_unreachable(); @@ -1605,14 +1602,14 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, } /* - * The conflict cause recorded previously should not change while the - * process owning the slot (if any) has been terminated. + * The invalidation cause recorded previously should not change while + * the process owning the slot (if any) has been terminated. */ - Assert(!(conflict_prev != RS_INVAL_NONE && terminated && - conflict_prev != conflict)); + Assert(!(invalidation_cause_prev != RS_INVAL_NONE && terminated && + invalidation_cause_prev != invalidation_cause)); - /* if there's no conflict, we're done */ - if (conflict == RS_INVAL_NONE) + /* if there's no invalidation, we're done */ + if (invalidation_cause == RS_INVAL_NONE) { SpinLockRelease(&s->mutex); if (released_lock) @@ -1632,13 +1629,13 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, { MyReplicationSlot = s; s->active_pid = MyProcPid; - s->data.invalidated = conflict; + s->data.invalidated = invalidation_cause; /* * XXX: We should consider not overwriting restart_lsn and instead * just rely on .invalidated. */ - if (conflict == RS_INVAL_WAL_REMOVED) + if (invalidation_cause == RS_INVAL_WAL_REMOVED) s->data.restart_lsn = InvalidXLogRecPtr; /* Let caller know */ @@ -1681,7 +1678,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, */ if (last_signaled_pid != active_pid) { - ReportSlotInvalidation(conflict, true, active_pid, + ReportSlotInvalidation(invalidation_cause, true, active_pid, slotname, restart_lsn, oldestLSN, snapshotConflictHorizon); @@ -1694,7 +1691,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, last_signaled_pid = active_pid; terminated = true; - conflict_prev = conflict; + invalidation_cause_prev = invalidation_cause; } /* Wait until the slot is released. */ @@ -1727,7 +1724,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, ReplicationSlotSave(); ReplicationSlotRelease(); - ReportSlotInvalidation(conflict, false, active_pid, + ReportSlotInvalidation(invalidation_cause, false, active_pid, slotname, restart_lsn, oldestLSN, snapshotConflictHorizon); @@ -2356,21 +2353,21 @@ RestoreSlotFromDisk(const char *name) } /* - * Maps a conflict reason for a replication slot to + * Maps an invalidation reason for a replication slot to * ReplicationSlotInvalidationCause. */ ReplicationSlotInvalidationCause -GetSlotInvalidationCause(const char *conflict_reason) +GetSlotInvalidationCause(const char *invalidation_reason) { ReplicationSlotInvalidationCause cause; ReplicationSlotInvalidationCause result = RS_INVAL_NONE; bool found PG_USED_FOR_ASSERTS_ONLY = false; - Assert(conflict_reason); + Assert(invalidation_reason); for (cause = RS_INVAL_NONE; cause <= RS_INVAL_MAX_CAUSES; cause++) { - if (strcmp(SlotInvalidationCauses[cause], conflict_reason) == 0) + if (strcmp(SlotInvalidationCauses[cause], invalidation_reason) == 0) { found = true; result = cause; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index ad79e1fccd..4232c1e52e 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 17 +#define PG_GET_REPLICATION_SLOTS_COLS 18 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -263,6 +263,7 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) bool nulls[PG_GET_REPLICATION_SLOTS_COLS]; WALAvailability walstate; int i; + ReplicationSlotInvalidationCause cause; if (!slot->in_use) continue; @@ -409,18 +410,28 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); - if (slot_contents.data.database == InvalidOid) + cause = slot_contents.data.invalidated; + + if (SlotIsPhysical(&slot_contents)) nulls[i++] = true; else { - ReplicationSlotInvalidationCause cause = slot_contents.data.invalidated; - - if (cause == RS_INVAL_NONE) - nulls[i++] = true; + /* + * rows_removed and wal_level_insufficient are the only two + * reasons for the logical slot's conflict with recovery. + */ + if (cause == RS_INVAL_HORIZON || + cause == RS_INVAL_WAL_LEVEL) + values[i++] = BoolGetDatum(true); else - values[i++] = CStringGetTextDatum(SlotInvalidationCauses[cause]); + values[i++] = BoolGetDatum(false); } + if (cause == RS_INVAL_NONE) + nulls[i++] = true; + else + values[i++] = CStringGetTextDatum(SlotInvalidationCauses[cause]); + values[i++] = BoolGetDatum(slot_contents.data.failover); values[i++] = BoolGetDatum(slot_contents.data.synced); diff --git a/src/bin/pg_upgrade/info.c b/src/bin/pg_upgrade/info.c index b5b8d11602..95c22a7200 100644 --- a/src/bin/pg_upgrade/info.c +++ b/src/bin/pg_upgrade/info.c @@ -676,13 +676,13 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) * removed. */ res = executeQueryOrDie(conn, "SELECT slot_name, plugin, two_phase, failover, " - "%s as caught_up, conflict_reason IS NOT NULL as invalid " + "%s as caught_up, invalidation_reason IS NOT NULL as invalid " "FROM pg_catalog.pg_replication_slots " "WHERE slot_type = 'logical' AND " "database = current_database() AND " "temporary IS FALSE;", live_check ? "FALSE" : - "(CASE WHEN conflict_reason IS NOT NULL THEN FALSE " + "(CASE WHEN invalidation_reason IS NOT NULL THEN FALSE " "ELSE (SELECT pg_catalog.binary_upgrade_logical_slot_has_caught_up(slot_name)) " "END)"); diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 042f66f714..71c74350a0 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflict_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 425effad21..7f25a083ee 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -273,7 +273,7 @@ extern void CheckPointReplicationSlots(bool is_shutdown); extern void CheckSlotRequirements(void); extern void CheckSlotPermissions(void); extern ReplicationSlotInvalidationCause - GetSlotInvalidationCause(const char *conflict_reason); + GetSlotInvalidationCause(const char *invalidation_reason); extern bool SlotExistsInStandbySlotNames(const char *slot_name); extern bool StandbySlotsHaveCaughtup(XLogRecPtr wait_for_lsn, int elevel); diff --git a/src/test/recovery/t/035_standby_logical_decoding.pl b/src/test/recovery/t/035_standby_logical_decoding.pl index 88b03048c4..8d6740c734 100644 --- a/src/test/recovery/t/035_standby_logical_decoding.pl +++ b/src/test/recovery/t/035_standby_logical_decoding.pl @@ -168,7 +168,7 @@ sub change_hot_standby_feedback_and_wait_for_xmins } } -# Check conflict_reason in pg_replication_slots. +# Check reason for conflict in pg_replication_slots. sub check_slots_conflict_reason { my ($slot_prefix, $reason) = @_; @@ -178,15 +178,15 @@ sub check_slots_conflict_reason $res = $node_standby->safe_psql( 'postgres', qq( - select conflict_reason from pg_replication_slots where slot_name = '$active_slot';)); + select invalidation_reason from pg_replication_slots where slot_name = '$active_slot' and conflicting;)); - is($res, "$reason", "$active_slot conflict_reason is $reason"); + is($res, "$reason", "$active_slot reason for conflict is $reason"); $res = $node_standby->safe_psql( 'postgres', qq( - select conflict_reason from pg_replication_slots where slot_name = '$inactive_slot';)); + select invalidation_reason from pg_replication_slots where slot_name = '$inactive_slot' and conflicting;)); - is($res, "$reason", "$inactive_slot conflict_reason is $reason"); + is($res, "$reason", "$inactive_slot reason for conflict is $reason"); } # Drop the slots, re-create them, change hot_standby_feedback, @@ -293,13 +293,13 @@ $node_primary->safe_psql('testdb', qq[SELECT * FROM pg_create_physical_replication_slot('$primary_slotname');] ); -# Check conflict_reason is NULL for physical slot +# Check conflicting is NULL for physical slot $res = $node_primary->safe_psql( 'postgres', qq[ - SELECT conflict_reason is null FROM pg_replication_slots where slot_name = '$primary_slotname';] + SELECT conflicting is null FROM pg_replication_slots where slot_name = '$primary_slotname';] ); -is($res, 't', "Physical slot reports conflict_reason as NULL"); +is($res, 't', "Physical slot reports conflicting as NULL"); my $backup_name = 'b1'; $node_primary->backup($backup_name); @@ -524,7 +524,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('vacuum_full_', 1, 'with vacuum FULL on pg_class'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('vacuum_full_', 'rows_removed'); # Ensure that replication slot stats are not removed after invalidation. @@ -551,7 +551,7 @@ change_hot_standby_feedback_and_wait_for_xmins(1, 1); ################################################## $node_standby->restart; -# Verify conflict_reason is retained across a restart. +# Verify reason for conflict is retained across a restart. check_slots_conflict_reason('vacuum_full_', 'rows_removed'); ################################################## @@ -560,7 +560,8 @@ check_slots_conflict_reason('vacuum_full_', 'rows_removed'); # Get the restart_lsn from an invalidated slot my $restart_lsn = $node_standby->safe_psql('postgres', - "SELECT restart_lsn from pg_replication_slots WHERE slot_name = 'vacuum_full_activeslot' and conflict_reason is not null;" + "SELECT restart_lsn FROM pg_replication_slots + WHERE slot_name = 'vacuum_full_activeslot' AND conflicting;" ); chomp($restart_lsn); @@ -611,7 +612,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('row_removal_', $logstart, 'with vacuum on pg_class'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('row_removal_', 'rows_removed'); $handle = @@ -647,7 +648,7 @@ $node_primary->wait_for_replay_catchup($node_standby); check_for_invalidation('shared_row_removal_', $logstart, 'with vacuum on pg_authid'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('shared_row_removal_', 'rows_removed'); $handle = make_slot_active($node_standby, 'shared_row_removal_', 0, \$stdout, @@ -700,8 +701,8 @@ ok( $node_standby->poll_query_until( is( $node_standby->safe_psql( 'postgres', q[select bool_or(conflicting) from - (select conflict_reason is not NULL as conflicting - from pg_replication_slots WHERE slot_type = 'logical')]), + (select conflicting from pg_replication_slots + where slot_type = 'logical')]), 'f', 'Logical slots are reported as non conflicting'); @@ -739,7 +740,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('pruning_', $logstart, 'with on-access pruning'); -# Verify conflict_reason is 'rows_removed' in pg_replication_slots +# Verify reason for conflict is 'rows_removed' in pg_replication_slots check_slots_conflict_reason('pruning_', 'rows_removed'); $handle = make_slot_active($node_standby, 'pruning_', 0, \$stdout, \$stderr); @@ -783,7 +784,7 @@ $node_primary->wait_for_replay_catchup($node_standby); # Check invalidation in the logfile and in pg_stat_database_conflicts check_for_invalidation('wal_level_', $logstart, 'due to wal_level'); -# Verify conflict_reason is 'wal_level_insufficient' in pg_replication_slots +# Verify reason for conflict is 'wal_level_insufficient' in pg_replication_slots check_slots_conflict_reason('wal_level_', 'wal_level_insufficient'); $handle = diff --git a/src/test/recovery/t/040_standby_failover_slots_sync.pl b/src/test/recovery/t/040_standby_failover_slots_sync.pl index 0ea1f3d323..f47bfd78eb 100644 --- a/src/test/recovery/t/040_standby_failover_slots_sync.pl +++ b/src/test/recovery/t/040_standby_failover_slots_sync.pl @@ -228,7 +228,7 @@ $standby1->safe_psql('postgres', "CHECKPOINT"); # Check if the synced slot is invalidated is( $standby1->safe_psql( 'postgres', - q{SELECT conflict_reason = 'wal_removed' FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} + q{SELECT invalidation_reason = 'wal_removed' FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} ), "t", 'synchronized slot has been invalidated'); @@ -274,7 +274,7 @@ $standby1->wait_for_log(qr/dropped replication slot "lsub1_slot" of dbid [0-9]+/ # flagged as 'synced' is( $standby1->safe_psql( 'postgres', - q{SELECT conflict_reason IS NULL AND synced AND NOT temporary FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} + q{SELECT invalidation_reason IS NULL AND synced AND NOT temporary FROM pg_replication_slots WHERE slot_name = 'lsub1_slot';} ), "t", 'logical slot is re-synced'); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 84e359f6ed..18829ea586 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,10 +1473,11 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, - l.conflict_reason, + l.conflicting, + l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflict_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 [application/x-patch] v14-0002-Track-last_inactive_at-in-pg_replication_slots.patch (6.9K, ../../CALj2ACWuNHJ3qBMmmy6i1YA9V8JDRSaciL2bBM+72bRcqiBE2g@mail.gmail.com/3-v14-0002-Track-last_inactive_at-in-pg_replication_slots.patch) download | inline diff: From eb5bb019863bb7eaa872357b3d9985f59dc56e9f Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Fri, 22 Mar 2024 02:59:07 +0000 Subject: [PATCH v14 2/6] Track last_inactive_at in pg_replication_slots --- doc/src/sgml/system-views.sgml | 11 +++++++++++ src/backend/catalog/system_views.sql | 3 ++- src/backend/replication/slot.c | 16 ++++++++++++++++ src/backend/replication/slotfuncs.c | 7 ++++++- src/include/catalog/pg_proc.dat | 6 +++--- src/include/replication/slot.h | 3 +++ src/test/regress/expected/rules.out | 5 +++-- 7 files changed, 44 insertions(+), 7 deletions(-) diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index b5da476c20..61378b3d4b 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2592,6 +2592,17 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>last_inactive_at</structfield> <type>timestamptz</type> + </para> + <para> + The time at which the slot became inactive. + <literal>NULL</literal> if the slot is currently actively being + used. + </para></entry> + </row> + </tbody> </tgroup> </table> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index f69b7f5580..e17f979c7f 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1026,7 +1026,8 @@ CREATE VIEW pg_replication_slots AS L.conflicting, L.invalidation_reason, L.failover, - L.synced + L.synced, + L.last_inactive_at FROM pg_get_replication_slots() AS L LEFT JOIN pg_database D ON (L.datoid = D.oid); diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index cdf0c450c5..146f0fbf84 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,6 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; + slot->last_inactive_at = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -622,6 +623,13 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); + if (s->data.persistency == RS_PERSISTENT) + { + SpinLockAcquire(&s->mutex); + s->last_inactive_at = 0; + SpinLockRelease(&s->mutex); + } + if (am_walsender) { ereport(log_replication_commands ? LOG : DEBUG1, @@ -691,6 +699,13 @@ ReplicationSlotRelease(void) ConditionVariableBroadcast(&slot->active_cv); } + if (slot->data.persistency == RS_PERSISTENT) + { + SpinLockAcquire(&slot->mutex); + slot->last_inactive_at = GetCurrentTimestamp(); + SpinLockRelease(&slot->mutex); + } + MyReplicationSlot = NULL; /* might not have been set when we've been a plain slot */ @@ -2341,6 +2356,7 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; + slot->last_inactive_at = 0; restored = true; break; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 4232c1e52e..75300f24b6 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 18 +#define PG_GET_REPLICATION_SLOTS_COLS 19 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -436,6 +436,11 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.synced); + if (slot_contents.last_inactive_at > 0) + values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_at); + else + nulls[i++] = true; + Assert(i == PG_GET_REPLICATION_SLOTS_COLS); tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 71c74350a0..bf13448ad4 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool,timestamptz}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced,last_inactive_at}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 7f25a083ee..b4bb7f5e99 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -201,6 +201,9 @@ typedef struct ReplicationSlot * forcibly flushed or not. */ XLogRecPtr last_saved_confirmed_flush; + + /* When did this slot become inactive last time? */ + TimestampTz last_inactive_at; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 18829ea586..effee2879e 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1476,8 +1476,9 @@ pg_replication_slots| SELECT l.slot_name, l.conflicting, l.invalidation_reason, l.failover, - l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) + l.synced, + l.last_inactive_at + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced, last_inactive_at) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 [application/x-patch] v14-0003-Allow-setting-inactive_timeout-for-replication-s.patch (35.4K, ../../CALj2ACWuNHJ3qBMmmy6i1YA9V8JDRSaciL2bBM+72bRcqiBE2g@mail.gmail.com/4-v14-0003-Allow-setting-inactive_timeout-for-replication-s.patch) download | inline diff: From 1fe40bcdd725858eab8d414d80f1234dcd0a4835 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Fri, 22 Mar 2024 03:55:02 +0000 Subject: [PATCH v14 3/6] Allow setting inactive_timeout for replication slots via SQL API --- contrib/test_decoding/expected/slot.out | 102 ++++++++++++++++++ contrib/test_decoding/sql/slot.sql | 34 ++++++ doc/src/sgml/func.sgml | 18 ++-- doc/src/sgml/system-views.sgml | 9 ++ src/backend/catalog/system_functions.sql | 2 + src/backend/catalog/system_views.sql | 3 +- src/backend/replication/logical/slotsync.c | 17 ++- src/backend/replication/slot.c | 20 +++- src/backend/replication/slotfuncs.c | 31 +++++- src/backend/replication/walsender.c | 4 +- src/bin/pg_upgrade/info.c | 6 +- src/bin/pg_upgrade/pg_upgrade.c | 5 +- src/bin/pg_upgrade/pg_upgrade.h | 2 + src/bin/pg_upgrade/t/003_logical_slots.pl | 11 +- src/include/catalog/pg_proc.dat | 22 ++-- src/include/replication/slot.h | 5 +- .../t/040_standby_failover_slots_sync.pl | 13 ++- src/test/regress/expected/rules.out | 5 +- 18 files changed, 266 insertions(+), 43 deletions(-) diff --git a/contrib/test_decoding/expected/slot.out b/contrib/test_decoding/expected/slot.out index 349ab2d380..6771520afb 100644 --- a/contrib/test_decoding/expected/slot.out +++ b/contrib/test_decoding/expected/slot.out @@ -466,3 +466,105 @@ SELECT pg_drop_replication_slot('physical_slot'); (1 row) +-- Test negative value for inactive_timeout option for slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', inactive_timeout := -300); -- error +ERROR: "inactive_timeout" must not be negative +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', inactive_timeout := -600); -- error +ERROR: "inactive_timeout" must not be negative +-- Test inactive_timeout option for temporary slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', temporary := true, inactive_timeout := 300); -- error +ERROR: cannot set inactive_timeout for a temporary replication slot +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', temporary := true, inactive_timeout := 600); -- error +ERROR: cannot set inactive_timeout for a temporary replication slot +-- Test inactive_timeout option of physical slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot1', immediately_reserve := true, inactive_timeout := 300); + ?column? +---------- + init +(1 row) + +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot2'); + ?column? +---------- + init +(1 row) + +-- Copy physical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); + ?column? +---------- + copy +(1 row) + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + slot_name | slot_type | inactive_timeout +--------------+-----------+------------------ + it_phy_slot1 | physical | 300 + it_phy_slot2 | physical | 0 + it_phy_slot3 | physical | 300 +(3 rows) + +SELECT pg_drop_replication_slot('it_phy_slot1'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_phy_slot2'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_phy_slot3'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +-- Test inactive_timeout option of logical slots. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); + ?column? +---------- + init +(1 row) + +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2', plugin := 'test_decoding'); + ?column? +---------- + init +(1 row) + +-- Copy logical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); + ?column? +---------- + copy +(1 row) + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + slot_name | slot_type | inactive_timeout +--------------+-----------+------------------ + it_log_slot1 | logical | 600 + it_log_slot2 | logical | 0 + it_log_slot3 | logical | 600 +(3 rows) + +SELECT pg_drop_replication_slot('it_log_slot1'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_log_slot2'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_log_slot3'); + pg_drop_replication_slot +-------------------------- + +(1 row) + diff --git a/contrib/test_decoding/sql/slot.sql b/contrib/test_decoding/sql/slot.sql index 580e3ae3be..443e91da07 100644 --- a/contrib/test_decoding/sql/slot.sql +++ b/contrib/test_decoding/sql/slot.sql @@ -190,3 +190,37 @@ SELECT pg_drop_replication_slot('failover_true_slot'); SELECT pg_drop_replication_slot('failover_false_slot'); SELECT pg_drop_replication_slot('failover_default_slot'); SELECT pg_drop_replication_slot('physical_slot'); + +-- Test negative value for inactive_timeout option for slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', inactive_timeout := -300); -- error +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', inactive_timeout := -600); -- error + +-- Test inactive_timeout option for temporary slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', temporary := true, inactive_timeout := 300); -- error +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', temporary := true, inactive_timeout := 600); -- error + +-- Test inactive_timeout option of physical slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot1', immediately_reserve := true, inactive_timeout := 300); +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot2'); + +-- Copy physical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + +SELECT pg_drop_replication_slot('it_phy_slot1'); +SELECT pg_drop_replication_slot('it_phy_slot2'); +SELECT pg_drop_replication_slot('it_phy_slot3'); + +-- Test inactive_timeout option of logical slots. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2', plugin := 'test_decoding'); + +-- Copy logical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + +SELECT pg_drop_replication_slot('it_log_slot1'); +SELECT pg_drop_replication_slot('it_log_slot2'); +SELECT pg_drop_replication_slot('it_log_slot3'); diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 8ecc02f2b9..afaafa35ad 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28373,7 +28373,7 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <indexterm> <primary>pg_create_physical_replication_slot</primary> </indexterm> - <function>pg_create_physical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type> <optional>, <parameter>immediately_reserve</parameter> <type>boolean</type>, <parameter>temporary</parameter> <type>boolean</type> </optional> ) + <function>pg_create_physical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type> <optional>, <parameter>immediately_reserve</parameter> <type>boolean</type>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>inactive_timeout</parameter> <type>integer</type> </optional>) <returnvalue>record</returnvalue> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>lsn</parameter> <type>pg_lsn</type> ) @@ -28390,9 +28390,12 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset parameter, <parameter>temporary</parameter>, when set to true, specifies that the slot should not be permanently stored to disk and is only meant for use by the current session. Temporary slots are also - released upon any error. This function corresponds - to the replication protocol command <literal>CREATE_REPLICATION_SLOT - ... PHYSICAL</literal>. + released upon any error. The optional fourth + parameter, <parameter>inactive_timeout</parameter>, when set to a + non-zero value, specifies the amount of time in seconds the slot is + allowed to be inactive. This function corresponds to the replication + protocol command + <literal>CREATE_REPLICATION_SLOT ... PHYSICAL</literal>. </para></entry> </row> @@ -28417,7 +28420,7 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <indexterm> <primary>pg_create_logical_replication_slot</primary> </indexterm> - <function>pg_create_logical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>plugin</parameter> <type>name</type> <optional>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>twophase</parameter> <type>boolean</type>, <parameter>failover</parameter> <type>boolean</type> </optional> ) + <function>pg_create_logical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>plugin</parameter> <type>name</type> <optional>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>twophase</parameter> <type>boolean</type>, <parameter>failover</parameter> <type>boolean</type>, <parameter>inactive_timeout</parameter> <type>integer</type> </optional> ) <returnvalue>record</returnvalue> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>lsn</parameter> <type>pg_lsn</type> ) @@ -28436,7 +28439,10 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <parameter>failover</parameter>, when set to true, specifies that this slot is enabled to be synced to the standbys so that logical replication can be resumed after - failover. A call to this function has the same effect as + failover. The optional sixth parameter, + <parameter>inactive_timeout</parameter>, when set to a + non-zero value, specifies the amount of time in seconds the slot is + allowed to be inactive. A call to this function has the same effect as the replication protocol command <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. </para></entry> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 61378b3d4b..f8838b1a23 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2761,6 +2761,15 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx ID of role </para></entry> </row> + + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>inactive_timeout</structfield> <type>integer</type> + </para> + <para> + The amount of time in seconds the slot is allowed to be inactive. + </para></entry> + </row> </tbody> </tgroup> </table> diff --git a/src/backend/catalog/system_functions.sql b/src/backend/catalog/system_functions.sql index fe2bb50f46..af27616657 100644 --- a/src/backend/catalog/system_functions.sql +++ b/src/backend/catalog/system_functions.sql @@ -469,6 +469,7 @@ AS 'pg_logical_emit_message_bytea'; CREATE OR REPLACE FUNCTION pg_create_physical_replication_slot( IN slot_name name, IN immediately_reserve boolean DEFAULT false, IN temporary boolean DEFAULT false, + IN inactive_timeout int DEFAULT 0, OUT slot_name name, OUT lsn pg_lsn) RETURNS RECORD LANGUAGE INTERNAL @@ -480,6 +481,7 @@ CREATE OR REPLACE FUNCTION pg_create_logical_replication_slot( IN temporary boolean DEFAULT false, IN twophase boolean DEFAULT false, IN failover boolean DEFAULT false, + IN inactive_timeout int DEFAULT 0, OUT slot_name name, OUT lsn pg_lsn) RETURNS RECORD LANGUAGE INTERNAL diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index e17f979c7f..6648b125d5 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1027,7 +1027,8 @@ CREATE VIEW pg_replication_slots AS L.invalidation_reason, L.failover, L.synced, - L.last_inactive_at + L.last_inactive_at, + L.inactive_timeout FROM pg_get_replication_slots() AS L LEFT JOIN pg_database D ON (L.datoid = D.oid); diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index 30480960c5..c01876ceeb 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -131,6 +131,7 @@ typedef struct RemoteSlot char *database; bool two_phase; bool failover; + int inactive_timeout; XLogRecPtr restart_lsn; XLogRecPtr confirmed_lsn; TransactionId catalog_xmin; @@ -167,7 +168,8 @@ update_local_synced_slot(RemoteSlot *remote_slot, Oid remote_dbid) remote_slot->two_phase == slot->data.two_phase && remote_slot->failover == slot->data.failover && remote_slot->confirmed_lsn == slot->data.confirmed_flush && - strcmp(remote_slot->plugin, NameStr(slot->data.plugin)) == 0) + strcmp(remote_slot->plugin, NameStr(slot->data.plugin)) == 0 && + remote_slot->inactive_timeout == slot->data.inactive_timeout) return false; /* Avoid expensive operations while holding a spinlock. */ @@ -182,6 +184,7 @@ update_local_synced_slot(RemoteSlot *remote_slot, Oid remote_dbid) slot->data.confirmed_flush = remote_slot->confirmed_lsn; slot->data.catalog_xmin = remote_slot->catalog_xmin; slot->effective_catalog_xmin = remote_slot->catalog_xmin; + slot->data.inactive_timeout = remote_slot->inactive_timeout; SpinLockRelease(&slot->mutex); if (xmin_changed) @@ -607,7 +610,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) ReplicationSlotCreate(remote_slot->name, true, RS_TEMPORARY, remote_slot->two_phase, remote_slot->failover, - true); + true, 0); /* For shorter lines. */ slot = MyReplicationSlot; @@ -627,6 +630,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) SpinLockAcquire(&slot->mutex); slot->effective_catalog_xmin = xmin_horizon; slot->data.catalog_xmin = xmin_horizon; + slot->data.inactive_timeout = remote_slot->inactive_timeout; SpinLockRelease(&slot->mutex); ReplicationSlotsComputeRequiredXmin(true); LWLockRelease(ProcArrayLock); @@ -652,9 +656,9 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) static bool synchronize_slots(WalReceiverConn *wrconn) { -#define SLOTSYNC_COLUMN_COUNT 9 +#define SLOTSYNC_COLUMN_COUNT 10 Oid slotRow[SLOTSYNC_COLUMN_COUNT] = {TEXTOID, TEXTOID, LSNOID, - LSNOID, XIDOID, BOOLOID, BOOLOID, TEXTOID, TEXTOID}; + LSNOID, XIDOID, BOOLOID, BOOLOID, TEXTOID, TEXTOID, INT4OID}; WalRcvExecResult *res; TupleTableSlot *tupslot; @@ -663,7 +667,7 @@ synchronize_slots(WalReceiverConn *wrconn) bool started_tx = false; const char *query = "SELECT slot_name, plugin, confirmed_flush_lsn," " restart_lsn, catalog_xmin, two_phase, failover," - " database, invalidation_reason" + " database, invalidation_reason, inactive_timeout" " FROM pg_catalog.pg_replication_slots" " WHERE failover and NOT temporary"; @@ -743,6 +747,9 @@ synchronize_slots(WalReceiverConn *wrconn) remote_slot->invalidated = isnull ? RS_INVAL_NONE : GetSlotInvalidationCause(TextDatumGetCString(d)); + remote_slot->inactive_timeout = DatumGetInt32(slot_getattr(tupslot, ++col, + &isnull)); + /* Sanity check */ Assert(col == SLOTSYNC_COLUMN_COUNT); diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 146f0fbf84..195771920f 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -129,7 +129,7 @@ StaticAssertDecl(lengthof(SlotInvalidationCauses) == (RS_INVAL_MAX_CAUSES + 1), sizeof(ReplicationSlotOnDisk) - ReplicationSlotOnDiskConstantSize #define SLOT_MAGIC 0x1051CA1 /* format identifier */ -#define SLOT_VERSION 5 /* version for new files */ +#define SLOT_VERSION 6 /* version for new files */ /* Control array for replication slot management */ ReplicationSlotCtlData *ReplicationSlotCtl = NULL; @@ -304,11 +304,14 @@ ReplicationSlotValidateName(const char *name, int elevel) * failover: If enabled, allows the slot to be synced to standbys so * that logical replication can be resumed after failover. * synced: True if the slot is synchronized from the primary server. + * inactive_timeout: The amount of time in seconds the slot is allowed to be + * inactive. */ void ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, - bool two_phase, bool failover, bool synced) + bool two_phase, bool failover, bool synced, + int inactive_timeout) { ReplicationSlot *slot = NULL; int i; @@ -345,6 +348,18 @@ ReplicationSlotCreate(const char *name, bool db_specific, errmsg("cannot enable failover for a temporary replication slot")); } + if (inactive_timeout > 0) + { + /* + * Do not allow users to set inactive_timeout for temporary slots, + * because temporary slots will not be saved to the disk. + */ + if (persistency == RS_TEMPORARY) + ereport(ERROR, + errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("cannot set inactive_timeout for a temporary replication slot")); + } + /* * If some other backend ran this code concurrently with us, we'd likely * both allocate the same slot, and that would be bad. We'd also be at @@ -398,6 +413,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->data.two_phase_at = InvalidXLogRecPtr; slot->data.failover = failover; slot->data.synced = synced; + slot->data.inactive_timeout = inactive_timeout; /* and then data only present in shared memory */ slot->just_dirtied = false; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 75300f24b6..326682138b 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -38,14 +38,15 @@ */ static void create_physical_replication_slot(char *name, bool immediately_reserve, - bool temporary, XLogRecPtr restart_lsn) + bool temporary, int inactive_timeout, + XLogRecPtr restart_lsn) { Assert(!MyReplicationSlot); /* acquire replication slot, this will check for conflicting names */ ReplicationSlotCreate(name, false, temporary ? RS_TEMPORARY : RS_PERSISTENT, false, - false, false); + false, false, inactive_timeout); if (immediately_reserve) { @@ -71,6 +72,7 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) Name name = PG_GETARG_NAME(0); bool immediately_reserve = PG_GETARG_BOOL(1); bool temporary = PG_GETARG_BOOL(2); + int inactive_timeout = PG_GETARG_INT32(3); Datum values[2]; bool nulls[2]; TupleDesc tupdesc; @@ -84,9 +86,15 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) CheckSlotRequirements(); + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + create_physical_replication_slot(NameStr(*name), immediately_reserve, temporary, + inactive_timeout, InvalidXLogRecPtr); values[0] = NameGetDatum(&MyReplicationSlot->data.name); @@ -120,7 +128,7 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) static void create_logical_replication_slot(char *name, char *plugin, bool temporary, bool two_phase, - bool failover, + bool failover, int inactive_timeout, XLogRecPtr restart_lsn, bool find_startpoint) { @@ -138,7 +146,7 @@ create_logical_replication_slot(char *name, char *plugin, */ ReplicationSlotCreate(name, true, temporary ? RS_TEMPORARY : RS_EPHEMERAL, two_phase, - failover, false); + failover, false, inactive_timeout); /* * Create logical decoding context to find start point or, if we don't @@ -177,6 +185,7 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) bool temporary = PG_GETARG_BOOL(2); bool two_phase = PG_GETARG_BOOL(3); bool failover = PG_GETARG_BOOL(4); + int inactive_timeout = PG_GETARG_INT32(5); Datum result; TupleDesc tupdesc; HeapTuple tuple; @@ -190,11 +199,17 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) CheckLogicalDecodingRequirements(); + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + create_logical_replication_slot(NameStr(*name), NameStr(*plugin), temporary, two_phase, failover, + inactive_timeout, InvalidXLogRecPtr, true); @@ -239,7 +254,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 19 +#define PG_GET_REPLICATION_SLOTS_COLS 20 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -441,6 +456,8 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) else nulls[i++] = true; + values[i++] = Int32GetDatum(slot_contents.data.inactive_timeout); + Assert(i == PG_GET_REPLICATION_SLOTS_COLS); tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, @@ -720,6 +737,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) XLogRecPtr src_restart_lsn; bool src_islogical; bool temporary; + int inactive_timeout; char *plugin; Datum values[2]; bool nulls[2]; @@ -776,6 +794,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) src_restart_lsn = first_slot_contents.data.restart_lsn; temporary = (first_slot_contents.data.persistency == RS_TEMPORARY); plugin = logical_slot ? NameStr(first_slot_contents.data.plugin) : NULL; + inactive_timeout = first_slot_contents.data.inactive_timeout; /* Check type of replication slot */ if (src_islogical != logical_slot) @@ -823,6 +842,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) temporary, false, false, + inactive_timeout, src_restart_lsn, false); } @@ -830,6 +850,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) create_physical_replication_slot(NameStr(*dst_name), true, temporary, + inactive_timeout, src_restart_lsn); /* diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index bc40c454de..5315c08650 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -1221,7 +1221,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) { ReplicationSlotCreate(cmd->slotname, false, cmd->temporary ? RS_TEMPORARY : RS_PERSISTENT, - false, false, false); + false, false, false, 0); if (reserve_wal) { @@ -1252,7 +1252,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) */ ReplicationSlotCreate(cmd->slotname, true, cmd->temporary ? RS_TEMPORARY : RS_EPHEMERAL, - two_phase, failover, false); + two_phase, failover, false, 0); /* * Do options check early so that we can bail before calling the diff --git a/src/bin/pg_upgrade/info.c b/src/bin/pg_upgrade/info.c index 95c22a7200..12626987f0 100644 --- a/src/bin/pg_upgrade/info.c +++ b/src/bin/pg_upgrade/info.c @@ -676,7 +676,8 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) * removed. */ res = executeQueryOrDie(conn, "SELECT slot_name, plugin, two_phase, failover, " - "%s as caught_up, invalidation_reason IS NOT NULL as invalid " + "%s as caught_up, invalidation_reason IS NOT NULL as invalid, " + "inactive_timeout " "FROM pg_catalog.pg_replication_slots " "WHERE slot_type = 'logical' AND " "database = current_database() AND " @@ -696,6 +697,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) int i_failover; int i_caught_up; int i_invalid; + int i_inactive_timeout; slotinfos = (LogicalSlotInfo *) pg_malloc(sizeof(LogicalSlotInfo) * num_slots); @@ -705,6 +707,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) i_failover = PQfnumber(res, "failover"); i_caught_up = PQfnumber(res, "caught_up"); i_invalid = PQfnumber(res, "invalid"); + i_inactive_timeout = PQfnumber(res, "inactive_timeout"); for (int slotnum = 0; slotnum < num_slots; slotnum++) { @@ -716,6 +719,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) curr->failover = (strcmp(PQgetvalue(res, slotnum, i_failover), "t") == 0); curr->caught_up = (strcmp(PQgetvalue(res, slotnum, i_caught_up), "t") == 0); curr->invalid = (strcmp(PQgetvalue(res, slotnum, i_invalid), "t") == 0); + curr->inactive_timeout = atooid(PQgetvalue(res, slotnum, i_inactive_timeout)); } } diff --git a/src/bin/pg_upgrade/pg_upgrade.c b/src/bin/pg_upgrade/pg_upgrade.c index f6143b6bc4..2656056103 100644 --- a/src/bin/pg_upgrade/pg_upgrade.c +++ b/src/bin/pg_upgrade/pg_upgrade.c @@ -931,9 +931,10 @@ create_logical_replication_slots(void) appendPQExpBuffer(query, ", "); appendStringLiteralConn(query, slot_info->plugin, conn); - appendPQExpBuffer(query, ", false, %s, %s);", + appendPQExpBuffer(query, ", false, %s, %s, %d);", slot_info->two_phase ? "true" : "false", - slot_info->failover ? "true" : "false"); + slot_info->failover ? "true" : "false", + slot_info->inactive_timeout); PQclear(executeQueryOrDie(conn, "%s", query->data)); diff --git a/src/bin/pg_upgrade/pg_upgrade.h b/src/bin/pg_upgrade/pg_upgrade.h index 92bcb693fb..eb86d000b1 100644 --- a/src/bin/pg_upgrade/pg_upgrade.h +++ b/src/bin/pg_upgrade/pg_upgrade.h @@ -162,6 +162,8 @@ typedef struct bool invalid; /* if true, the slot is unusable */ bool failover; /* is the slot designated to be synced to the * physical standby? */ + int inactive_timeout; /* The amount of time in seconds the slot + * is allowed to be inactive. */ } LogicalSlotInfo; typedef struct diff --git a/src/bin/pg_upgrade/t/003_logical_slots.pl b/src/bin/pg_upgrade/t/003_logical_slots.pl index 83d71c3084..6e82d2cb7b 100644 --- a/src/bin/pg_upgrade/t/003_logical_slots.pl +++ b/src/bin/pg_upgrade/t/003_logical_slots.pl @@ -153,14 +153,17 @@ like( # TEST: Successful upgrade # Preparations for the subsequent test: -# 1. Setup logical replication (first, cleanup slots from the previous tests) +# 1. Setup logical replication (first, cleanup slots from the previous tests, +# and then create slot for this test with inactive_timeout set). my $old_connstr = $oldpub->connstr . ' dbname=postgres'; +my $inactive_timeout = 3600; $oldpub->start; $oldpub->safe_psql( 'postgres', qq[ SELECT * FROM pg_drop_replication_slot('test_slot1'); SELECT * FROM pg_drop_replication_slot('test_slot2'); + SELECT pg_create_logical_replication_slot(slot_name := 'regress_sub', plugin := 'pgoutput', inactive_timeout := $inactive_timeout); CREATE PUBLICATION regress_pub FOR ALL TABLES; ]); @@ -172,7 +175,7 @@ $sub->start; $sub->safe_psql( 'postgres', qq[ CREATE TABLE tbl (a int); - CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (two_phase = 'true', failover = 'true') + CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (slot_name = 'regress_sub', create_slot = false, two_phase = 'true', failover = 'true') ]); $sub->wait_for_subscription_sync($oldpub, 'regress_sub'); @@ -192,8 +195,8 @@ command_ok([@pg_upgrade_cmd], 'run of pg_upgrade of old cluster'); # Check that the slot 'regress_sub' has migrated to the new cluster $newpub->start; my $result = $newpub->safe_psql('postgres', - "SELECT slot_name, two_phase, failover FROM pg_replication_slots"); -is($result, qq(regress_sub|t|t), 'check the slot exists on new cluster'); + "SELECT slot_name, two_phase, failover, inactive_timeout = $inactive_timeout FROM pg_replication_slots"); +is($result, qq(regress_sub|t|t|t), 'check the slot exists on new cluster'); # Update the connection my $new_connstr = $newpub->connstr . ' dbname=postgres'; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index bf13448ad4..50db6b68d0 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11105,10 +11105,10 @@ # replication slots { oid => '3779', descr => 'create a physical replication slot', proname => 'pg_create_physical_replication_slot', provolatile => 'v', - proparallel => 'u', prorettype => 'record', proargtypes => 'name bool bool', - proallargtypes => '{name,bool,bool,name,pg_lsn}', - proargmodes => '{i,i,i,o,o}', - proargnames => '{slot_name,immediately_reserve,temporary,slot_name,lsn}', + proparallel => 'u', prorettype => 'record', proargtypes => 'name bool bool int4', + proallargtypes => '{name,bool,bool,int4,name,pg_lsn}', + proargmodes => '{i,i,i,i,o,o}', + proargnames => '{slot_name,immediately_reserve,temporary,inactive_timeout,slot_name,lsn}', prosrc => 'pg_create_physical_replication_slot' }, { oid => '4220', descr => 'copy a physical replication slot, changing temporality', @@ -11133,17 +11133,17 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool,timestamptz}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced,last_inactive_at}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool,timestamptz,int4}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced,last_inactive_at,inactive_timeout}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', proparallel => 'u', prorettype => 'record', - proargtypes => 'name name bool bool bool', - proallargtypes => '{name,name,bool,bool,bool,name,pg_lsn}', - proargmodes => '{i,i,i,i,i,o,o}', - proargnames => '{slot_name,plugin,temporary,twophase,failover,slot_name,lsn}', + proargtypes => 'name name bool bool bool int4', + proallargtypes => '{name,name,bool,bool,bool,int4,name,pg_lsn}', + proargmodes => '{i,i,i,i,i,i,o,o}', + proargnames => '{slot_name,plugin,temporary,twophase,failover,inactive_timeout,slot_name,lsn}', prosrc => 'pg_create_logical_replication_slot' }, { oid => '4222', descr => 'copy a logical replication slot, changing temporality and plugin', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index b4bb7f5e99..ff62542b03 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -127,6 +127,9 @@ typedef struct ReplicationSlotPersistentData * for logical slots on the primary server. */ bool failover; + + /* The amount of time in seconds the slot is allowed to be inactive. */ + int inactive_timeout; } ReplicationSlotPersistentData; /* @@ -239,7 +242,7 @@ extern void ReplicationSlotsShmemInit(void); extern void ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, bool two_phase, bool failover, - bool synced); + bool synced, int inactive_timeout); extern void ReplicationSlotPersist(void); extern void ReplicationSlotDrop(const char *name, bool nowait); extern void ReplicationSlotDropAcquired(void); diff --git a/src/test/recovery/t/040_standby_failover_slots_sync.pl b/src/test/recovery/t/040_standby_failover_slots_sync.pl index f47bfd78eb..3dd780beab 100644 --- a/src/test/recovery/t/040_standby_failover_slots_sync.pl +++ b/src/test/recovery/t/040_standby_failover_slots_sync.pl @@ -152,8 +152,9 @@ log_min_messages = 'debug2' $primary->append_conf('postgresql.conf', "log_min_messages = 'debug2'"); $primary->reload; +my $inactive_timeout = 3600; $primary->psql('postgres', - q{SELECT pg_create_logical_replication_slot('lsub2_slot', 'test_decoding', false, false, true);} + "SELECT pg_create_logical_replication_slot('lsub2_slot', 'test_decoding', false, false, true, $inactive_timeout);" ); $primary->psql('postgres', @@ -190,6 +191,16 @@ is( $standby1->safe_psql( "t", 'logical slots have synced as true on standby'); +# Confirm that the synced slot on the standby has got inactive_timeout from the +# primary. +is( $standby1->safe_psql( + 'postgres', + "SELECT inactive_timeout = $inactive_timeout FROM pg_replication_slots + WHERE slot_name = 'lsub2_slot' AND synced AND NOT temporary;" + ), + "t", + 'synced logical slot has got inactive_timeout on standby'); + ################################################## # Test that the synchronized slot will be dropped if the corresponding remote # slot on the primary server has been dropped. diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index effee2879e..adf7b8947f 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1477,8 +1477,9 @@ pg_replication_slots| SELECT l.slot_name, l.invalidation_reason, l.failover, l.synced, - l.last_inactive_at - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced, last_inactive_at) + l.last_inactive_at, + l.inactive_timeout + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced, last_inactive_at, inactive_timeout) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 [application/x-patch] v14-0004-Introduce-new-SQL-funtion-pg_alter_replication_s.patch (15.7K, ../../CALj2ACWuNHJ3qBMmmy6i1YA9V8JDRSaciL2bBM+72bRcqiBE2g@mail.gmail.com/5-v14-0004-Introduce-new-SQL-funtion-pg_alter_replication_s.patch) download | inline diff: From a0163b1f67dad275ff84fd1c5ebe290a19ebeb07 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Fri, 22 Mar 2024 06:32:39 +0000 Subject: [PATCH v14 4/6] Introduce new SQL funtion pg_alter_replication_slot This commit adds a new function pg_alter_replication_slot to alter the given property of a replication slot. It is similar to replication protocol command ALTER_REPLICATION_SLOT, except that for now it allows only inactive_timeout property to be set. The reason for disallowing failover property to be altered via this function is to avoid inconsistency with the catalog pg_subscription on the logical subscriber. Because, the subscriber won't know the altered value of its replication slot on the publisher. --- contrib/test_decoding/expected/slot.out | 44 ++++++++++++++- contrib/test_decoding/sql/slot.sql | 10 ++++ doc/src/sgml/func.sgml | 21 ++++++++ src/backend/replication/slot.c | 22 ++++---- src/backend/replication/slotfuncs.c | 66 ++++++++++++++++++++++- src/bin/pg_upgrade/t/003_logical_slots.pl | 14 +++-- src/include/catalog/pg_proc.dat | 5 ++ src/include/replication/slot.h | 2 + 8 files changed, 167 insertions(+), 17 deletions(-) diff --git a/contrib/test_decoding/expected/slot.out b/contrib/test_decoding/expected/slot.out index 6771520afb..5b8dbf6f52 100644 --- a/contrib/test_decoding/expected/slot.out +++ b/contrib/test_decoding/expected/slot.out @@ -496,13 +496,27 @@ SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_sl copy (1 row) +-- Test alter physical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot4'); + ?column? +---------- + init +(1 row) + +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_phy_slot4', inactive_timeout := 900); + ?column? +---------- + alter +(1 row) + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; slot_name | slot_type | inactive_timeout --------------+-----------+------------------ it_phy_slot1 | physical | 300 it_phy_slot2 | physical | 0 it_phy_slot3 | physical | 300 -(3 rows) + it_phy_slot4 | physical | 900 +(4 rows) SELECT pg_drop_replication_slot('it_phy_slot1'); pg_drop_replication_slot @@ -522,6 +536,12 @@ SELECT pg_drop_replication_slot('it_phy_slot3'); (1 row) +SELECT pg_drop_replication_slot('it_phy_slot4'); + pg_drop_replication_slot +-------------------------- + +(1 row) + -- Test inactive_timeout option of logical slots. SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); ?column? @@ -542,13 +562,27 @@ SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slo copy (1 row) +-- Test alter logical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot4', plugin := 'test_decoding'); + ?column? +---------- + init +(1 row) + +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_log_slot4', inactive_timeout := 900); + ?column? +---------- + alter +(1 row) + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; slot_name | slot_type | inactive_timeout --------------+-----------+------------------ it_log_slot1 | logical | 600 it_log_slot2 | logical | 0 it_log_slot3 | logical | 600 -(3 rows) + it_log_slot4 | logical | 900 +(4 rows) SELECT pg_drop_replication_slot('it_log_slot1'); pg_drop_replication_slot @@ -568,3 +602,9 @@ SELECT pg_drop_replication_slot('it_log_slot3'); (1 row) +SELECT pg_drop_replication_slot('it_log_slot4'); + pg_drop_replication_slot +-------------------------- + +(1 row) + diff --git a/contrib/test_decoding/sql/slot.sql b/contrib/test_decoding/sql/slot.sql index 443e91da07..6785714cc7 100644 --- a/contrib/test_decoding/sql/slot.sql +++ b/contrib/test_decoding/sql/slot.sql @@ -206,11 +206,16 @@ SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot -- Copy physical slot with inactive_timeout option set. SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); +-- Test alter physical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot4'); +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_phy_slot4', inactive_timeout := 900); + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; SELECT pg_drop_replication_slot('it_phy_slot1'); SELECT pg_drop_replication_slot('it_phy_slot2'); SELECT pg_drop_replication_slot('it_phy_slot3'); +SELECT pg_drop_replication_slot('it_phy_slot4'); -- Test inactive_timeout option of logical slots. SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); @@ -219,8 +224,13 @@ SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2 -- Copy logical slot with inactive_timeout option set. SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); +-- Test alter logical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot4', plugin := 'test_decoding'); +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_log_slot4', inactive_timeout := 900); + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; SELECT pg_drop_replication_slot('it_log_slot1'); SELECT pg_drop_replication_slot('it_log_slot2'); SELECT pg_drop_replication_slot('it_log_slot3'); +SELECT pg_drop_replication_slot('it_log_slot4'); diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index afaafa35ad..22c8e0d39c 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28829,6 +28829,27 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset </entry> </row> + <row> + <entry role="func_table_entry"><para role="func_signature"> + <indexterm> + <primary>pg_alter_replication_slot</primary> + </indexterm> + <function>pg_alter_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>inactive_timeout</parameter> <type>integer</type> ) + <returnvalue>void</returnvalue> + </para> + <para> + Alters the given property of a replication slot + named <parameter>slot_name</parameter>. Same as replication protocol + command <literal>ALTER_REPLICATION_SLOT</literal>, except that it + allows only <parameter>inactive_timeout</parameter> property to be set. + The reason for disallowing <parameter>failover</parameter> property to + be altered via this function is to avoid inconsistency with the catalog + <structname>pg_subscription</structname> on the logical subscriber. + Because, the subscriber won't know the altered value of its + replication slot on the publisher. + </para></entry> + </row> + </tbody> </tgroup> </table> diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 195771920f..5644765a7e 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -162,7 +162,6 @@ static void ReplicationSlotDropPtr(ReplicationSlot *slot); /* internal persistency functions */ static void RestoreSlotFromDisk(const char *name); static void CreateSlotOnDisk(ReplicationSlot *slot); -static void SaveSlotToPath(ReplicationSlot *slot, const char *dir, int elevel); /* * Report shared-memory space needed by ReplicationSlotsShmemInit. @@ -865,6 +864,7 @@ ReplicationSlotAlter(const char *name, bool failover) ReplicationSlotRelease(); } + /* * Permanently drop the currently acquired replication slot. */ @@ -1000,7 +1000,7 @@ ReplicationSlotSave(void) Assert(MyReplicationSlot != NULL); sprintf(path, "pg_replslot/%s", NameStr(MyReplicationSlot->data.name)); - SaveSlotToPath(MyReplicationSlot, path, ERROR); + ReplicationSlotSaveToPath(MyReplicationSlot, path, ERROR); } /* @@ -1863,7 +1863,10 @@ CheckPointReplicationSlots(bool is_shutdown) if (!s->in_use) continue; - /* save the slot to disk, locking is handled in SaveSlotToPath() */ + /* + * Save the slot to disk, locking is handled in + * ReplicationSlotSaveToPath. + */ sprintf(path, "pg_replslot/%s", NameStr(s->data.name)); /* @@ -1889,7 +1892,7 @@ CheckPointReplicationSlots(bool is_shutdown) SpinLockRelease(&s->mutex); } - SaveSlotToPath(s, path, LOG); + ReplicationSlotSaveToPath(s, path, LOG); } LWLockRelease(ReplicationSlotAllocationLock); } @@ -1968,8 +1971,9 @@ CreateSlotOnDisk(ReplicationSlot *slot) /* * No need to take out the io_in_progress_lock, nobody else can see this - * slot yet, so nobody else will write. We're reusing SaveSlotToPath which - * takes out the lock, if we'd take the lock here, we'd deadlock. + * slot yet, so nobody else will write. We're reusing + * ReplicationSlotSaveToPath which takes out the lock, if we'd take the + * lock here, we'd deadlock. */ sprintf(path, "pg_replslot/%s", NameStr(slot->data.name)); @@ -1995,7 +1999,7 @@ CreateSlotOnDisk(ReplicationSlot *slot) /* Write the actual state file. */ slot->dirty = true; /* signal that we really need to write */ - SaveSlotToPath(slot, tmppath, ERROR); + ReplicationSlotSaveToPath(slot, tmppath, ERROR); /* Rename the directory into place. */ if (rename(tmppath, path) != 0) @@ -2020,8 +2024,8 @@ CreateSlotOnDisk(ReplicationSlot *slot) /* * Shared functionality between saving and creating a replication slot. */ -static void -SaveSlotToPath(ReplicationSlot *slot, const char *dir, int elevel) +void +ReplicationSlotSaveToPath(ReplicationSlot *slot, const char *dir, int elevel) { char tmppath[MAXPGPATH]; char path[MAXPGPATH]; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 326682138b..d6ef14fba6 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -229,7 +229,6 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) PG_RETURN_DATUM(result); } - /* * SQL function for dropping a replication slot. */ @@ -1038,3 +1037,68 @@ pg_sync_replication_slots(PG_FUNCTION_ARGS) PG_RETURN_VOID(); } + +/* + * SQL function for altering given properties of a replication slot. + */ +Datum +pg_alter_replication_slot(PG_FUNCTION_ARGS) +{ + Name name = PG_GETARG_NAME(0); + int inactive_timeout = PG_GETARG_INT32(1); + ReplicationSlot *slot; + char path[MAXPGPATH]; + + CheckSlotPermissions(); + + CheckSlotRequirements(); + + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + /* Check if the slot exits with the given name. */ + slot = SearchNamedReplicationSlot(NameStr(*name), false); + + if (!slot) + ereport(ERROR, + (errcode(ERRCODE_INVALID_PARAMETER_VALUE), + errmsg("replication slot \"%s\" does not exist", + NameStr(*name)))); + + /* + * Do not allow users to set inactive_timeout for temporary slots because + * temporary, slots will not be saved to the disk. + */ + if (slot->data.persistency == RS_TEMPORARY) + ereport(ERROR, + errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("cannot set inactive_timeout for a temporary replication slot")); + + LWLockRelease(ReplicationSlotControlLock); + + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + + /* + * We need to briefly prevent any other backend from acquiring the slot + * while we set the property. Without holding the ControlLock exclusively, + * a concurrent ReplicationSlotAcquire() could acquire the slot as well. + */ + LWLockAcquire(ReplicationSlotControlLock, LW_EXCLUSIVE); + + SpinLockAcquire(&slot->mutex); + slot->data.inactive_timeout = inactive_timeout; + + /* Make sure the invalidated state persists across server restart */ + slot->just_dirtied = true; + slot->dirty = true; + SpinLockRelease(&slot->mutex); + + sprintf(path, "pg_replslot/%s", NameStr(slot->data.name)); + ReplicationSlotSaveToPath(slot, path, ERROR); + + LWLockRelease(ReplicationSlotControlLock); + + PG_RETURN_VOID(); +} diff --git a/src/bin/pg_upgrade/t/003_logical_slots.pl b/src/bin/pg_upgrade/t/003_logical_slots.pl index 6e82d2cb7b..b79db24f42 100644 --- a/src/bin/pg_upgrade/t/003_logical_slots.pl +++ b/src/bin/pg_upgrade/t/003_logical_slots.pl @@ -153,17 +153,14 @@ like( # TEST: Successful upgrade # Preparations for the subsequent test: -# 1. Setup logical replication (first, cleanup slots from the previous tests, -# and then create slot for this test with inactive_timeout set). +# 1. Setup logical replication (first, cleanup slots from the previous tests) my $old_connstr = $oldpub->connstr . ' dbname=postgres'; -my $inactive_timeout = 3600; $oldpub->start; $oldpub->safe_psql( 'postgres', qq[ SELECT * FROM pg_drop_replication_slot('test_slot1'); SELECT * FROM pg_drop_replication_slot('test_slot2'); - SELECT pg_create_logical_replication_slot(slot_name := 'regress_sub', plugin := 'pgoutput', inactive_timeout := $inactive_timeout); CREATE PUBLICATION regress_pub FOR ALL TABLES; ]); @@ -175,7 +172,7 @@ $sub->start; $sub->safe_psql( 'postgres', qq[ CREATE TABLE tbl (a int); - CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (slot_name = 'regress_sub', create_slot = false, two_phase = 'true', failover = 'true') + CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (two_phase = 'true', failover = 'true') ]); $sub->wait_for_subscription_sync($oldpub, 'regress_sub'); @@ -185,6 +182,13 @@ my $twophase_query = $sub->poll_query_until('postgres', $twophase_query) or die "Timed out while waiting for subscriber to enable twophase"; +# Alter slot to set inactive_timeout +my $inactive_timeout = 3600; +$oldpub->safe_psql( + 'postgres', qq[ + SELECT pg_alter_replication_slot(slot_name := 'regress_sub', inactive_timeout := $inactive_timeout); +]); + # 2. Temporarily disable the subscription $sub->safe_psql('postgres', "ALTER SUBSCRIPTION regress_sub DISABLE"); $oldpub->stop; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 50db6b68d0..b83e2f39b1 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11222,6 +11222,11 @@ proname => 'pg_sync_replication_slots', provolatile => 'v', proparallel => 'u', prorettype => 'void', proargtypes => '', prosrc => 'pg_sync_replication_slots' }, +{ oid => '9039', descr => 'alter given properties of a replication slot', + proname => 'pg_alter_replication_slot', provolatile => 'v', proparallel => 'u', + prorettype => 'void', proargtypes => 'name int4', + proargnames => '{slot_name,inactive_timeout}', + prosrc => 'pg_alter_replication_slot' }, # event triggers { oid => '3566', descr => 'list objects dropped by the current command', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index ff62542b03..a8d7d42a07 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -252,6 +252,8 @@ extern void ReplicationSlotAcquire(const char *name, bool nowait); extern void ReplicationSlotRelease(void); extern void ReplicationSlotCleanup(void); extern void ReplicationSlotSave(void); +extern void ReplicationSlotSaveToPath(ReplicationSlot *slot, const char *dir, + int elevel); extern void ReplicationSlotMarkDirty(void); /* misc stuff */ -- 2.34.1 [application/x-patch] v14-0005-Allow-setting-inactive_timeout-in-the-replicatio.patch (17.9K, ../../CALj2ACWuNHJ3qBMmmy6i1YA9V8JDRSaciL2bBM+72bRcqiBE2g@mail.gmail.com/6-v14-0005-Allow-setting-inactive_timeout-in-the-replicatio.patch) download | inline diff: From bcc949abc9521eac3c16353fdf2783ced57eebae Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Fri, 22 Mar 2024 06:55:45 +0000 Subject: [PATCH v14 5/6] Allow setting inactive_timeout in the replication commands --- doc/src/sgml/protocol.sgml | 20 ++++++ src/backend/commands/subscriptioncmds.c | 6 +- .../libpqwalreceiver/libpqwalreceiver.c | 61 ++++++++++++++++--- src/backend/replication/logical/tablesync.c | 1 + src/backend/replication/slot.c | 30 ++++++++- src/backend/replication/walreceiver.c | 2 +- src/backend/replication/walsender.c | 38 +++++++++--- src/include/replication/slot.h | 3 +- src/include/replication/walreceiver.h | 11 ++-- src/test/recovery/t/001_stream_rep.pl | 50 +++++++++++++++ 10 files changed, 195 insertions(+), 27 deletions(-) diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index a5cb19357f..2ffa1b470a 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -2068,6 +2068,16 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" </para> </listitem> </varlistentry> + + <varlistentry> + <term><literal>INACTIVE_TIMEOUT [ <replaceable class="parameter">integer</replaceable> ]</literal></term> + <listitem> + <para> + If set to a non-zero value, specifies the amount of time in seconds + the slot is allowed to be inactive. The default is zero. + </para> + </listitem> + </varlistentry> </variablelist> <para> @@ -2168,6 +2178,16 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" </para> </listitem> </varlistentry> + + <varlistentry> + <term><literal>INACTIVE_TIMEOUT [ <replaceable class="parameter">integer</replaceable> ]</literal></term> + <listitem> + <para> + If set to a non-zero value, specifies the amount of time in seconds + the slot is allowed to be inactive. The default is zero. + </para> + </listitem> + </varlistentry> </variablelist> </listitem> diff --git a/src/backend/commands/subscriptioncmds.c b/src/backend/commands/subscriptioncmds.c index 5a47fa984d..4562de49c4 100644 --- a/src/backend/commands/subscriptioncmds.c +++ b/src/backend/commands/subscriptioncmds.c @@ -827,7 +827,7 @@ CreateSubscription(ParseState *pstate, CreateSubscriptionStmt *stmt, twophase_enabled = true; walrcv_create_slot(wrconn, opts.slot_name, false, twophase_enabled, - opts.failover, CRS_NOEXPORT_SNAPSHOT, NULL); + opts.failover, 0, CRS_NOEXPORT_SNAPSHOT, NULL); if (twophase_enabled) UpdateTwoPhaseState(subid, LOGICALREP_TWOPHASE_STATE_ENABLED); @@ -849,7 +849,7 @@ CreateSubscription(ParseState *pstate, CreateSubscriptionStmt *stmt, else if (opts.slot_name && (opts.failover || walrcv_server_version(wrconn) >= 170000)) { - walrcv_alter_slot(wrconn, opts.slot_name, opts.failover); + walrcv_alter_slot(wrconn, opts.slot_name, &opts.failover, NULL); } } PG_FINALLY(); @@ -1541,7 +1541,7 @@ AlterSubscription(ParseState *pstate, AlterSubscriptionStmt *stmt, PG_TRY(); { - walrcv_alter_slot(wrconn, sub->slotname, opts.failover); + walrcv_alter_slot(wrconn, sub->slotname, &opts.failover, NULL); } PG_FINALLY(); { diff --git a/src/backend/replication/libpqwalreceiver/libpqwalreceiver.c b/src/backend/replication/libpqwalreceiver/libpqwalreceiver.c index 761bf0f677..126250a076 100644 --- a/src/backend/replication/libpqwalreceiver/libpqwalreceiver.c +++ b/src/backend/replication/libpqwalreceiver/libpqwalreceiver.c @@ -77,10 +77,11 @@ static char *libpqrcv_create_slot(WalReceiverConn *conn, bool temporary, bool two_phase, bool failover, + int inactive_timeout, CRSSnapshotAction snapshot_action, XLogRecPtr *lsn); static void libpqrcv_alter_slot(WalReceiverConn *conn, const char *slotname, - bool failover); + bool *failover, int *inactive_timeout); static pid_t libpqrcv_get_backend_pid(WalReceiverConn *conn); static WalRcvExecResult *libpqrcv_exec(WalReceiverConn *conn, const char *query, @@ -1008,7 +1009,8 @@ libpqrcv_send(WalReceiverConn *conn, const char *buffer, int nbytes) */ static char * libpqrcv_create_slot(WalReceiverConn *conn, const char *slotname, - bool temporary, bool two_phase, bool failover, + bool temporary, bool two_phase, + bool failover, int inactive_timeout, CRSSnapshotAction snapshot_action, XLogRecPtr *lsn) { PGresult *res; @@ -1048,6 +1050,15 @@ libpqrcv_create_slot(WalReceiverConn *conn, const char *slotname, appendStringInfoChar(&cmd, ' '); } + if (inactive_timeout > 0) + { + appendStringInfo(&cmd, "INACTIVE_TIMEOUT %d", inactive_timeout); + if (use_new_options_syntax) + appendStringInfoString(&cmd, ", "); + else + appendStringInfoChar(&cmd, ' '); + } + if (use_new_options_syntax) { switch (snapshot_action) @@ -1084,10 +1095,24 @@ libpqrcv_create_slot(WalReceiverConn *conn, const char *slotname, } else { + appendStringInfoString(&cmd, " PHYSICAL "); if (use_new_options_syntax) - appendStringInfoString(&cmd, " PHYSICAL (RESERVE_WAL)"); - else - appendStringInfoString(&cmd, " PHYSICAL RESERVE_WAL"); + appendStringInfoChar(&cmd, '('); + + appendStringInfoString(&cmd, "RESERVE_WAL"); + + if (inactive_timeout > 0) + { + if (use_new_options_syntax) + appendStringInfoString(&cmd, ", "); + else + appendStringInfoChar(&cmd, ' '); + + appendStringInfo(&cmd, "INACTIVE_TIMEOUT %d", inactive_timeout); + } + + if (use_new_options_syntax) + appendStringInfoChar(&cmd, ')'); } res = libpqrcv_PQexec(conn->streamConn, cmd.data); @@ -1121,15 +1146,33 @@ libpqrcv_create_slot(WalReceiverConn *conn, const char *slotname, */ static void libpqrcv_alter_slot(WalReceiverConn *conn, const char *slotname, - bool failover) + bool *failover, int *inactive_timeout) { StringInfoData cmd; PGresult *res; + bool specified_prev_opt = false; initStringInfo(&cmd); - appendStringInfo(&cmd, "ALTER_REPLICATION_SLOT %s ( FAILOVER %s )", - quote_identifier(slotname), - failover ? "true" : "false"); + appendStringInfo(&cmd, "ALTER_REPLICATION_SLOT %s (", + quote_identifier(slotname)); + + if (failover != NULL) + { + appendStringInfo(&cmd, "FAILOVER %s", + *failover ? "true" : "false"); + specified_prev_opt = true; + } + + if (inactive_timeout != NULL) + { + if (specified_prev_opt) + appendStringInfoString(&cmd, ", "); + + appendStringInfo(&cmd, "INACTIVE_TIMEOUT %d", *inactive_timeout); + specified_prev_opt = true; + } + + appendStringInfoChar(&cmd, ')'); res = libpqrcv_PQexec(conn->streamConn, cmd.data); pfree(cmd.data); diff --git a/src/backend/replication/logical/tablesync.c b/src/backend/replication/logical/tablesync.c index 1061d5b61b..59f8e5fbaa 100644 --- a/src/backend/replication/logical/tablesync.c +++ b/src/backend/replication/logical/tablesync.c @@ -1431,6 +1431,7 @@ LogicalRepSyncTableStart(XLogRecPtr *origin_startpos) walrcv_create_slot(LogRepWorkerWalRcvConn, slotname, false /* permanent */ , false /* two_phase */ , MySubscription->failover, + 0, CRS_USE_SNAPSHOT, origin_startpos); /* diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 5644765a7e..3680a608c3 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -807,8 +807,10 @@ ReplicationSlotDrop(const char *name, bool nowait) * Change the definition of the slot identified by the specified name. */ void -ReplicationSlotAlter(const char *name, bool failover) +ReplicationSlotAlter(const char *name, bool failover, int inactive_timeout) { + bool lock_acquired; + Assert(MyReplicationSlot == NULL); ReplicationSlotAcquire(name, false); @@ -851,10 +853,36 @@ ReplicationSlotAlter(const char *name, bool failover) errcode(ERRCODE_FEATURE_NOT_SUPPORTED), errmsg("cannot enable failover for a temporary replication slot")); + /* + * Do not allow users to set inactive_timeout for temporary slots because + * temporary, slots will not be saved to the disk. + */ + if (inactive_timeout > 0 && MyReplicationSlot->data.persistency == RS_TEMPORARY) + ereport(ERROR, + errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("cannot set inactive_timeout for a temporary replication slot")); + + lock_acquired = false; if (MyReplicationSlot->data.failover != failover) { SpinLockAcquire(&MyReplicationSlot->mutex); + lock_acquired = true; MyReplicationSlot->data.failover = failover; + } + + if (MyReplicationSlot->data.inactive_timeout != inactive_timeout) + { + if (!lock_acquired) + { + SpinLockAcquire(&MyReplicationSlot->mutex); + lock_acquired = true; + } + + MyReplicationSlot->data.inactive_timeout = inactive_timeout; + } + + if (lock_acquired) + { SpinLockRelease(&MyReplicationSlot->mutex); ReplicationSlotMarkDirty(); diff --git a/src/backend/replication/walreceiver.c b/src/backend/replication/walreceiver.c index acda5f68d9..ac2ebb0c69 100644 --- a/src/backend/replication/walreceiver.c +++ b/src/backend/replication/walreceiver.c @@ -389,7 +389,7 @@ WalReceiverMain(char *startup_data, size_t startup_data_len) "pg_walreceiver_%lld", (long long int) walrcv_get_backend_pid(wrconn)); - walrcv_create_slot(wrconn, slotname, true, false, false, 0, NULL); + walrcv_create_slot(wrconn, slotname, true, false, false, 0, 0, NULL); SpinLockAcquire(&walrcv->mutex); strlcpy(walrcv->slotname, slotname, NAMEDATALEN); diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 5315c08650..0420274247 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -1123,13 +1123,15 @@ static void parseCreateReplSlotOptions(CreateReplicationSlotCmd *cmd, bool *reserve_wal, CRSSnapshotAction *snapshot_action, - bool *two_phase, bool *failover) + bool *two_phase, bool *failover, + int *inactive_timeout) { ListCell *lc; bool snapshot_action_given = false; bool reserve_wal_given = false; bool two_phase_given = false; bool failover_given = false; + bool inactive_timeout_given = false; /* Parse options */ foreach(lc, cmd->options) @@ -1188,6 +1190,15 @@ parseCreateReplSlotOptions(CreateReplicationSlotCmd *cmd, failover_given = true; *failover = defGetBoolean(defel); } + else if (strcmp(defel->defname, "inactive_timeout") == 0) + { + if (inactive_timeout_given) + ereport(ERROR, + (errcode(ERRCODE_SYNTAX_ERROR), + errmsg("conflicting or redundant options"))); + inactive_timeout_given = true; + *inactive_timeout = defGetInt32(defel); + } else elog(ERROR, "unrecognized option: %s", defel->defname); } @@ -1205,6 +1216,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) bool reserve_wal = false; bool two_phase = false; bool failover = false; + int inactive_timeout = 0; CRSSnapshotAction snapshot_action = CRS_EXPORT_SNAPSHOT; DestReceiver *dest; TupOutputState *tstate; @@ -1215,13 +1227,13 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) Assert(!MyReplicationSlot); parseCreateReplSlotOptions(cmd, &reserve_wal, &snapshot_action, &two_phase, - &failover); + &failover, &inactive_timeout); if (cmd->kind == REPLICATION_KIND_PHYSICAL) { ReplicationSlotCreate(cmd->slotname, false, cmd->temporary ? RS_TEMPORARY : RS_PERSISTENT, - false, false, false, 0); + false, false, false, inactive_timeout); if (reserve_wal) { @@ -1252,7 +1264,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) */ ReplicationSlotCreate(cmd->slotname, true, cmd->temporary ? RS_TEMPORARY : RS_EPHEMERAL, - two_phase, failover, false, 0); + two_phase, failover, false, inactive_timeout); /* * Do options check early so that we can bail before calling the @@ -1411,9 +1423,11 @@ DropReplicationSlot(DropReplicationSlotCmd *cmd) * Process extra options given to ALTER_REPLICATION_SLOT. */ static void -ParseAlterReplSlotOptions(AlterReplicationSlotCmd *cmd, bool *failover) +ParseAlterReplSlotOptions(AlterReplicationSlotCmd *cmd, bool *failover, + int *inactive_timeout) { bool failover_given = false; + bool inactive_timeout_given = false; /* Parse options */ foreach_ptr(DefElem, defel, cmd->options) @@ -1427,6 +1441,15 @@ ParseAlterReplSlotOptions(AlterReplicationSlotCmd *cmd, bool *failover) failover_given = true; *failover = defGetBoolean(defel); } + else if (strcmp(defel->defname, "inactive_timeout") == 0) + { + if (inactive_timeout_given) + ereport(ERROR, + (errcode(ERRCODE_SYNTAX_ERROR), + errmsg("conflicting or redundant options"))); + inactive_timeout_given = true; + *inactive_timeout = defGetInt32(defel); + } else elog(ERROR, "unrecognized option: %s", defel->defname); } @@ -1439,9 +1462,10 @@ static void AlterReplicationSlot(AlterReplicationSlotCmd *cmd) { bool failover = false; + int inactive_timeout = 0; - ParseAlterReplSlotOptions(cmd, &failover); - ReplicationSlotAlter(cmd->slotname, failover); + ParseAlterReplSlotOptions(cmd, &failover, &inactive_timeout); + ReplicationSlotAlter(cmd->slotname, failover, inactive_timeout); } /* diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index a8d7d42a07..9cd4bf98e5 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -246,7 +246,8 @@ extern void ReplicationSlotCreate(const char *name, bool db_specific, extern void ReplicationSlotPersist(void); extern void ReplicationSlotDrop(const char *name, bool nowait); extern void ReplicationSlotDropAcquired(void); -extern void ReplicationSlotAlter(const char *name, bool failover); +extern void ReplicationSlotAlter(const char *name, bool failover, + int inactive_timeout); extern void ReplicationSlotAcquire(const char *name, bool nowait); extern void ReplicationSlotRelease(void); diff --git a/src/include/replication/walreceiver.h b/src/include/replication/walreceiver.h index 12f71fa99b..038812fd24 100644 --- a/src/include/replication/walreceiver.h +++ b/src/include/replication/walreceiver.h @@ -366,6 +366,7 @@ typedef char *(*walrcv_create_slot_fn) (WalReceiverConn *conn, bool temporary, bool two_phase, bool failover, + int inactive_timeout, CRSSnapshotAction snapshot_action, XLogRecPtr *lsn); @@ -377,7 +378,7 @@ typedef char *(*walrcv_create_slot_fn) (WalReceiverConn *conn, */ typedef void (*walrcv_alter_slot_fn) (WalReceiverConn *conn, const char *slotname, - bool failover); + bool *failover, int *inactive_timeout); /* * walrcv_get_backend_pid_fn @@ -453,10 +454,10 @@ extern PGDLLIMPORT WalReceiverFunctionsType *WalReceiverFunctions; WalReceiverFunctions->walrcv_receive(conn, buffer, wait_fd) #define walrcv_send(conn, buffer, nbytes) \ WalReceiverFunctions->walrcv_send(conn, buffer, nbytes) -#define walrcv_create_slot(conn, slotname, temporary, two_phase, failover, snapshot_action, lsn) \ - WalReceiverFunctions->walrcv_create_slot(conn, slotname, temporary, two_phase, failover, snapshot_action, lsn) -#define walrcv_alter_slot(conn, slotname, failover) \ - WalReceiverFunctions->walrcv_alter_slot(conn, slotname, failover) +#define walrcv_create_slot(conn, slotname, temporary, two_phase, failover, inactive_timeout, snapshot_action, lsn) \ + WalReceiverFunctions->walrcv_create_slot(conn, slotname, temporary, two_phase, failover, inactive_timeout, snapshot_action, lsn) +#define walrcv_alter_slot(conn, slotname, failover, inactive_timeout) \ + WalReceiverFunctions->walrcv_alter_slot(conn, slotname, failover, inactive_timeout) #define walrcv_get_backend_pid(conn) \ WalReceiverFunctions->walrcv_get_backend_pid(conn) #define walrcv_exec(conn, exec, nRetTypes, retTypes) \ diff --git a/src/test/recovery/t/001_stream_rep.pl b/src/test/recovery/t/001_stream_rep.pl index 5311ade509..db00b6aa24 100644 --- a/src/test/recovery/t/001_stream_rep.pl +++ b/src/test/recovery/t/001_stream_rep.pl @@ -604,4 +604,54 @@ ok( pump_until( 'base backup cleanly canceled'); $sigchld_bb->finish(); +# Drop any existing slots on the primary, for the follow-up tests. +$node_primary->safe_psql('postgres', + "SELECT pg_drop_replication_slot(slot_name) FROM pg_replication_slots;"); + +# Test setting inactive_timeout option via replication commands. +$node_primary->append_conf( + 'postgresql.conf', qq( +wal_level = logical +)); +$node_primary->restart; + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_phy_slot1 PHYSICAL (RESERVE_WAL, INACTIVE_TIMEOUT 100);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_phy_slot2 PHYSICAL (RESERVE_WAL);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "ALTER_REPLICATION_SLOT it_phy_slot2 (INACTIVE_TIMEOUT 200);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_log_slot1 LOGICAL pgoutput (TWO_PHASE, INACTIVE_TIMEOUT 300);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_log_slot2 LOGICAL pgoutput;", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "ALTER_REPLICATION_SLOT it_log_slot2 (INACTIVE_TIMEOUT 400);", + extra_params => [ '-d', $connstr_db ]); + +my $slot_info_expected = 'it_log_slot1|logical|300 +it_log_slot2|logical|400 +it_phy_slot1|physical|100 +it_phy_slot2|physical|0'; + +my $slot_info = $node_primary->safe_psql('postgres', + qq[SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1;]); +is($slot_info, $slot_info_expected, "replication slots with inactive_timeout on primary exist"); + done_testing(); -- 2.34.1 [application/x-patch] v14-0006-Add-inactive_timeout-based-replication-slot-inva.patch (32.1K, ../../CALj2ACWuNHJ3qBMmmy6i1YA9V8JDRSaciL2bBM+72bRcqiBE2g@mail.gmail.com/7-v14-0006-Add-inactive_timeout-based-replication-slot-inva.patch) download | inline diff: From 0a30fab6610a1197f58124d276369ac89f7cba99 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Fri, 22 Mar 2024 07:54:21 +0000 Subject: [PATCH v14 6/6] Add inactive_timeout based replication slot invalidation --- doc/src/sgml/func.sgml | 12 +- doc/src/sgml/system-views.sgml | 10 +- .../replication/logical/logicalfuncs.c | 4 +- src/backend/replication/logical/slotsync.c | 8 +- src/backend/replication/slot.c | 240 ++++++++++++++++-- src/backend/replication/slotfuncs.c | 27 +- src/backend/replication/walsender.c | 12 +- src/backend/tcop/postgres.c | 2 +- src/backend/utils/adt/pg_upgrade_support.c | 4 +- src/include/replication/slot.h | 11 +- src/test/recovery/meson.build | 1 + src/test/recovery/t/050_invalidate_slots.pl | 170 +++++++++++++ 12 files changed, 455 insertions(+), 46 deletions(-) create mode 100644 src/test/recovery/t/050_invalidate_slots.pl diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 22c8e0d39c..4826e45c7d 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28393,8 +28393,8 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset released upon any error. The optional fourth parameter, <parameter>inactive_timeout</parameter>, when set to a non-zero value, specifies the amount of time in seconds the slot is - allowed to be inactive. This function corresponds to the replication - protocol command + allowed to be inactive before getting invalidated. + This function corresponds to the replication protocol command <literal>CREATE_REPLICATION_SLOT ... PHYSICAL</literal>. </para></entry> </row> @@ -28439,12 +28439,12 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <parameter>failover</parameter>, when set to true, specifies that this slot is enabled to be synced to the standbys so that logical replication can be resumed after - failover. The optional sixth parameter, + failover. The optional sixth parameter, <parameter>inactive_timeout</parameter>, when set to a non-zero value, specifies the amount of time in seconds the slot is - allowed to be inactive. A call to this function has the same effect as - the replication protocol command - <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. + allowed to be inactive before getting invalidated. + A call to this function has the same effect as the replication protocol + command <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. </para></entry> </row> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index f8838b1a23..8e7d9c9105 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2563,6 +2563,13 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx perform logical decoding. It is set only for logical slots. </para> </listitem> + <listitem> + <para> + <literal>inactive_timeout</literal> means that the slot has been + inactive for the duration specified by slot's + <literal>inactive_timeout</literal> parameter. + </para> + </listitem> </itemizedlist> </para></entry> </row> @@ -2767,7 +2774,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <structfield>inactive_timeout</structfield> <type>integer</type> </para> <para> - The amount of time in seconds the slot is allowed to be inactive. + The amount of time in seconds the slot is allowed to be inactive before + getting invalidated. </para></entry> </row> </tbody> diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index b4dd5cce75..53cf8bbd42 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -197,7 +197,7 @@ pg_logical_slot_get_changes_guts(FunctionCallInfo fcinfo, bool confirm, bool bin else end_of_wal = GetXLogReplayRecPtr(NULL); - ReplicationSlotAcquire(NameStr(*name), true); + ReplicationSlotAcquire(NameStr(*name), true, true); PG_TRY(); { @@ -309,7 +309,7 @@ pg_logical_slot_get_changes_guts(FunctionCallInfo fcinfo, bool confirm, bool bin /* free context, call shutdown callback */ FreeDecodingContext(ctx); - ReplicationSlotRelease(); + ReplicationSlotRelease(true); InvalidateSystemCaches(); } PG_CATCH(); diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index c01876ceeb..5aba117e2b 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -319,7 +319,7 @@ drop_local_obsolete_slots(List *remote_slot_list) if (synced_slot) { - ReplicationSlotAcquire(NameStr(local_slot->data.name), true); + ReplicationSlotAcquire(NameStr(local_slot->data.name), true, false); ReplicationSlotDropAcquired(); } @@ -529,7 +529,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) * InvalidatePossiblyObsoleteSlot() where it invalidates slot directly * if the slot is not acquired by other processes. */ - ReplicationSlotAcquire(remote_slot->name, true); + ReplicationSlotAcquire(remote_slot->name, true, false); Assert(slot == MyReplicationSlot); @@ -554,7 +554,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) /* Skip the sync of an invalidated slot */ if (slot->data.invalidated != RS_INVAL_NONE) { - ReplicationSlotRelease(); + ReplicationSlotRelease(false); return slot_updated; } @@ -640,7 +640,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) slot_updated = true; } - ReplicationSlotRelease(); + ReplicationSlotRelease(false); return slot_updated; } diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 3680a608c3..0acf1d1960 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -107,10 +107,11 @@ const char *const SlotInvalidationCauses[] = { [RS_INVAL_WAL_REMOVED] = "wal_removed", [RS_INVAL_HORIZON] = "rows_removed", [RS_INVAL_WAL_LEVEL] = "wal_level_insufficient", + [RS_INVAL_INACTIVE_TIMEOUT] = "inactive_timeout", }; /* Maximum number of invalidation causes */ -#define RS_INVAL_MAX_CAUSES RS_INVAL_WAL_LEVEL +#define RS_INVAL_MAX_CAUSES RS_INVAL_INACTIVE_TIMEOUT StaticAssertDecl(lengthof(SlotInvalidationCauses) == (RS_INVAL_MAX_CAUSES + 1), "array length mismatch"); @@ -158,6 +159,9 @@ static XLogRecPtr ss_oldest_flush_lsn = InvalidXLogRecPtr; static void ReplicationSlotShmemExit(int code, Datum arg); static void ReplicationSlotDropPtr(ReplicationSlot *slot); +static bool InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex); /* internal persistency functions */ static void RestoreSlotFromDisk(const char *name); @@ -233,7 +237,7 @@ ReplicationSlotShmemExit(int code, Datum arg) { /* Make sure active replication slots are released */ if (MyReplicationSlot != NULL) - ReplicationSlotRelease(); + ReplicationSlotRelease(true); /* Also cleanup all the temporary slots. */ ReplicationSlotCleanup(); @@ -424,7 +428,19 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; - slot->last_inactive_at = 0; + + /* + * We set last_inactive_at after creation of the slot so that the + * inactive_timeout if set is honored. + * + * There's no point in allowing failover slots to get invalidated based on + * slot's inactive_timeout parameter on standby. The failover slots simply + * get synced from the primary on the standby. + */ + if (!(RecoveryInProgress() && slot->data.failover)) + slot->last_inactive_at = GetCurrentTimestamp(); + else + slot->last_inactive_at = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -550,9 +566,14 @@ ReplicationSlotName(int index, Name name) * * An error is raised if nowait is true and the slot is currently in use. If * nowait is false, we sleep until the slot is released by the owning process. + * + * If check_for_invalidation is true, the slot is checked for invalidation + * based on its inactive_timeout parameter and an error is raised after making + * the slot ours. */ void -ReplicationSlotAcquire(const char *name, bool nowait) +ReplicationSlotAcquire(const char *name, bool nowait, + bool check_for_invalidation) { ReplicationSlot *s; int active_pid; @@ -630,6 +651,42 @@ retry: /* We made this slot active, so it's ours now. */ MyReplicationSlot = s; + /* + * Check if the given slot can be invalidated based on its + * inactive_timeout parameter. If yes, persist the invalidated state to + * disk and then error out. We do this only after making the slot ours to + * avoid anyone else acquiring it while we check for its invalidation. + */ + if (check_for_invalidation) + { + /* The slot is ours by now */ + Assert(s->active_pid == MyProcPid); + + /* + * Well, the slot is not yet ours really unless we check for the + * invalidation below. + */ + s->active_pid = 0; + if (InvalidateReplicationSlotForInactiveTimeout(s, true, true, true)) + { + /* + * If the slot has been invalidated, recalculate the resource + * limits. + */ + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + + /* Might need it for slot clean up on error, so restore it */ + s->active_pid = MyProcPid; + ereport(ERROR, + (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), + errmsg("cannot acquire invalidated replication slot \"%s\"", + NameStr(MyReplicationSlot->data.name)), + errdetail("This slot has been invalidated because of its inactive_timeout parameter."))); + } + s->active_pid = MyProcPid; + } + /* * The call to pgstat_acquire_replslot() protects against stats for a * different slot, from before a restart or such, being present during @@ -663,7 +720,7 @@ retry: * Resources this slot requires will be preserved. */ void -ReplicationSlotRelease(void) +ReplicationSlotRelease(bool set_last_inactive_at) { ReplicationSlot *slot = MyReplicationSlot; char *slotname = NULL; /* keep compiler quiet */ @@ -714,11 +771,20 @@ ReplicationSlotRelease(void) ConditionVariableBroadcast(&slot->active_cv); } - if (slot->data.persistency == RS_PERSISTENT) + if (set_last_inactive_at && + slot->data.persistency == RS_PERSISTENT) { - SpinLockAcquire(&slot->mutex); - slot->last_inactive_at = GetCurrentTimestamp(); - SpinLockRelease(&slot->mutex); + /* + * There's no point in allowing failover slots to get invalidated + * based on slot's inactive_timeout parameter on standby. The failover + * slots simply get synced from the primary on the standby. + */ + if (!(RecoveryInProgress() && slot->data.failover)) + { + SpinLockAcquire(&slot->mutex); + slot->last_inactive_at = GetCurrentTimestamp(); + SpinLockRelease(&slot->mutex); + } } MyReplicationSlot = NULL; @@ -788,7 +854,7 @@ ReplicationSlotDrop(const char *name, bool nowait) { Assert(MyReplicationSlot == NULL); - ReplicationSlotAcquire(name, nowait); + ReplicationSlotAcquire(name, nowait, false); /* * Do not allow users to drop the slots which are currently being synced @@ -813,7 +879,7 @@ ReplicationSlotAlter(const char *name, bool failover, int inactive_timeout) Assert(MyReplicationSlot == NULL); - ReplicationSlotAcquire(name, false); + ReplicationSlotAcquire(name, false, true); if (SlotIsPhysical(MyReplicationSlot)) ereport(ERROR, @@ -889,7 +955,7 @@ ReplicationSlotAlter(const char *name, bool failover, int inactive_timeout) ReplicationSlotSave(); } - ReplicationSlotRelease(); + ReplicationSlotRelease(true); } @@ -1542,6 +1608,9 @@ ReportSlotInvalidation(ReplicationSlotInvalidationCause cause, case RS_INVAL_WAL_LEVEL: appendStringInfoString(&err_detail, _("Logical decoding on standby requires wal_level >= logical on the primary server.")); break; + case RS_INVAL_INACTIVE_TIMEOUT: + appendStringInfoString(&err_detail, _("The slot has been inactive for more than the time specified by slot's inactive_timeout parameter.")); + break; case RS_INVAL_NONE: pg_unreachable(); } @@ -1655,6 +1724,10 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, if (SlotIsLogical(s)) invalidation_cause = cause; break; + case RS_INVAL_INACTIVE_TIMEOUT: + if (InvalidateReplicationSlotForInactiveTimeout(s, false, false, false)) + invalidation_cause = cause; + break; case RS_INVAL_NONE: pg_unreachable(); } @@ -1781,7 +1854,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, /* Make sure the invalidated state persists across server restart */ ReplicationSlotMarkDirty(); ReplicationSlotSave(); - ReplicationSlotRelease(); + ReplicationSlotRelease(true); ReportSlotInvalidation(invalidation_cause, false, active_pid, slotname, restart_lsn, @@ -1808,6 +1881,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, * - RS_INVAL_HORIZON: requires a snapshot <= the given horizon in the given * db; dboid may be InvalidOid for shared relations * - RS_INVAL_WAL_LEVEL: is logical + * - RS_INVAL_INACTIVE_TIMEOUT: inactive slot timeout occurs * * NB - this runs as part of checkpoint, so avoid raising errors if possible. */ @@ -1859,6 +1933,110 @@ restart: return invalidated; } +/* + * Invalidate given slot based on its inactive_timeout parameter. + * + * Returns true if the slot has got invalidated. + * + * NB - this function also runs as part of checkpoint, so avoid raising errors + * if possible. + */ +bool +InvalidateReplicationSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex, + bool persist_state) +{ + if (!InvalidateSlotForInactiveTimeout(slot, need_control_lock, need_mutex)) + return false; + + Assert(slot->active_pid == 0); + + SpinLockAcquire(&slot->mutex); + slot->data.invalidated = RS_INVAL_INACTIVE_TIMEOUT; + + /* Make sure the invalidated state persists across server restart */ + slot->just_dirtied = true; + slot->dirty = true; + SpinLockRelease(&slot->mutex); + + if (persist_state) + { + char path[MAXPGPATH]; + + sprintf(path, "pg_replslot/%s", NameStr(slot->data.name)); + ReplicationSlotSaveToPath(slot, path, ERROR); + } + + ReportSlotInvalidation(RS_INVAL_INACTIVE_TIMEOUT, false, 0, + slot->data.name, InvalidXLogRecPtr, + InvalidXLogRecPtr, InvalidTransactionId); + + return true; +} + +/* + * Helper for InvalidateReplicationSlotForInactiveTimeout + */ +static bool +InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex) +{ + ReplicationSlotInvalidationCause inavidation_cause = RS_INVAL_NONE; + + if (slot->last_inactive_at == 0 || + slot->data.inactive_timeout == 0) + return false; + + /* inactive_timeout is only tracked for permanent slots */ + if (slot->data.persistency != RS_PERSISTENT) + return false; + + /* + * There's no point in allowing failover slots to get invalidated based on + * slot's inactive_timeout parameter on standby. The failover slots simply + * get synced from the primary on the standby. + */ + if (RecoveryInProgress() && slot->data.failover) + return false; + + if (need_control_lock) + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); + + /* + * Check if the slot needs to be invalidated due to inactive_timeout. We + * do this with the spinlock held to avoid race conditions -- for example + * the restart_lsn could move forward, or the slot could be dropped. + */ + if (need_mutex) + SpinLockAcquire(&slot->mutex); + + if (slot->last_inactive_at > 0 && + slot->data.inactive_timeout > 0) + { + TimestampTz now; + + /* last_inactive_at is only tracked for inactive slots */ + Assert(slot->active_pid == 0); + + now = GetCurrentTimestamp(); + if (TimestampDifferenceExceeds(slot->last_inactive_at, now, + slot->data.inactive_timeout * 1000)) + inavidation_cause = RS_INVAL_INACTIVE_TIMEOUT; + } + + if (need_mutex) + SpinLockRelease(&slot->mutex); + + if (need_control_lock) + LWLockRelease(ReplicationSlotControlLock); + + return (inavidation_cause == RS_INVAL_INACTIVE_TIMEOUT); +} + /* * Flush all replication slots to disk. * @@ -1871,6 +2049,7 @@ void CheckPointReplicationSlots(bool is_shutdown) { int i; + bool invalidated = false; elog(DEBUG1, "performing replication slot checkpoint"); @@ -1892,10 +2071,11 @@ CheckPointReplicationSlots(bool is_shutdown) continue; /* - * Save the slot to disk, locking is handled in - * ReplicationSlotSaveToPath. + * Here's an opportunity to invalidate inactive replication slots + * based on timeout, so let's do it. */ - sprintf(path, "pg_replslot/%s", NameStr(s->data.name)); + if (InvalidateReplicationSlotForInactiveTimeout(s, true, true, false)) + invalidated = true; /* * Slot's data is not flushed each time the confirmed_flush LSN is @@ -1920,9 +2100,21 @@ CheckPointReplicationSlots(bool is_shutdown) SpinLockRelease(&s->mutex); } + /* + * Save the slot to disk, locking is handled in + * ReplicationSlotSaveToPath. + */ + sprintf(path, "pg_replslot/%s", NameStr(s->data.name)); ReplicationSlotSaveToPath(s, path, LOG); } LWLockRelease(ReplicationSlotAllocationLock); + + /* If the slot has been invalidated, recalculate the resource limits */ + if (invalidated) + { + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + } } /* @@ -2404,7 +2596,21 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; - slot->last_inactive_at = 0; + + /* + * We set last_inactive_at only if inactive_timeout of the slot is + * specified so that the timeout is honored after the slot is restored + * from the disk. + * + * There's no point in allowing failover slots to get invalidated + * based on slot's inactive_timeout parameter on standby. The failover + * slots simply get synced from the primary on the standby. + */ + if (slot->data.inactive_timeout > 0 && + !(RecoveryInProgress() && slot->data.failover)) + slot->last_inactive_at = GetCurrentTimestamp(); + else + slot->last_inactive_at = 0; restored = true; break; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index d6ef14fba6..7cc5c8bdf6 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -111,7 +111,7 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) tuple = heap_form_tuple(tupdesc, values, nulls); result = HeapTupleGetDatum(tuple); - ReplicationSlotRelease(); + ReplicationSlotRelease(false); PG_RETURN_DATUM(result); } @@ -224,7 +224,7 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) /* ok, slot is now fully created, mark it as persistent if needed */ if (!temporary) ReplicationSlotPersist(); - ReplicationSlotRelease(); + ReplicationSlotRelease(false); PG_RETURN_DATUM(result); } @@ -257,6 +257,7 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; + bool invalidated = false; /* * We don't require any special permission to see this function's data @@ -287,6 +288,13 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) slot_contents = *slot; SpinLockRelease(&slot->mutex); + /* + * Here's an opportunity to invalidate inactive replication slots + * based on timeout, so let's do it. + */ + if (InvalidateReplicationSlotForInactiveTimeout(slot, false, true, true)) + invalidated = true; + memset(values, 0, sizeof(values)); memset(nulls, 0, sizeof(nulls)); @@ -465,6 +473,15 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) LWLockRelease(ReplicationSlotControlLock); + /* + * If the slot has been invalidated, recalculate the resource limits + */ + if (invalidated) + { + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + } + return (Datum) 0; } @@ -667,7 +684,7 @@ pg_replication_slot_advance(PG_FUNCTION_ARGS) moveto = Min(moveto, GetXLogReplayRecPtr(NULL)); /* Acquire the slot so we "own" it */ - ReplicationSlotAcquire(NameStr(*slotname), true); + ReplicationSlotAcquire(NameStr(*slotname), true, true); /* A slot whose restart_lsn has never been reserved cannot be advanced */ if (XLogRecPtrIsInvalid(MyReplicationSlot->data.restart_lsn)) @@ -710,7 +727,7 @@ pg_replication_slot_advance(PG_FUNCTION_ARGS) ReplicationSlotsComputeRequiredXmin(false); ReplicationSlotsComputeRequiredLSN(); - ReplicationSlotRelease(); + ReplicationSlotRelease(true); /* Return the reached position. */ values[1] = LSNGetDatum(endlsn); @@ -954,7 +971,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) tuple = heap_form_tuple(tupdesc, values, nulls); result = HeapTupleGetDatum(tuple); - ReplicationSlotRelease(); + ReplicationSlotRelease(false); PG_RETURN_DATUM(result); } diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 0420274247..b6795048cc 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -334,7 +334,7 @@ WalSndErrorCleanup(void) wal_segment_close(xlogreader); if (MyReplicationSlot != NULL) - ReplicationSlotRelease(); + ReplicationSlotRelease(true); ReplicationSlotCleanup(); @@ -846,7 +846,7 @@ StartReplication(StartReplicationCmd *cmd) if (cmd->slotname) { - ReplicationSlotAcquire(cmd->slotname, true); + ReplicationSlotAcquire(cmd->slotname, true, true); if (SlotIsLogical(MyReplicationSlot)) ereport(ERROR, (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), @@ -992,7 +992,7 @@ StartReplication(StartReplicationCmd *cmd) } if (cmd->slotname) - ReplicationSlotRelease(); + ReplicationSlotRelease(true); /* * Copy is finished now. Send a single-row result set indicating the next @@ -1407,7 +1407,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) do_tup_output(tstate, values, nulls); end_tup_output(tstate); - ReplicationSlotRelease(); + ReplicationSlotRelease(false); } /* @@ -1483,7 +1483,7 @@ StartLogicalReplication(StartReplicationCmd *cmd) Assert(!MyReplicationSlot); - ReplicationSlotAcquire(cmd->slotname, true); + ReplicationSlotAcquire(cmd->slotname, true, true); /* * Force a disconnect, so that the decoding code doesn't need to care @@ -1545,7 +1545,7 @@ StartLogicalReplication(StartReplicationCmd *cmd) WalSndLoop(XLogSendLogical); FreeDecodingContext(logical_decoding_ctx); - ReplicationSlotRelease(); + ReplicationSlotRelease(true); replication_active = false; if (got_STOPPING) diff --git a/src/backend/tcop/postgres.c b/src/backend/tcop/postgres.c index fd4199a098..749de2741e 100644 --- a/src/backend/tcop/postgres.c +++ b/src/backend/tcop/postgres.c @@ -4407,7 +4407,7 @@ PostgresMain(const char *dbname, const char *username) * callback ensuring correct cleanup on FATAL errors. */ if (MyReplicationSlot != NULL) - ReplicationSlotRelease(); + ReplicationSlotRelease(true); /* We also want to cleanup temporary slots on error. */ ReplicationSlotCleanup(); diff --git a/src/backend/utils/adt/pg_upgrade_support.c b/src/backend/utils/adt/pg_upgrade_support.c index c54b08fe18..d56ecf4137 100644 --- a/src/backend/utils/adt/pg_upgrade_support.c +++ b/src/backend/utils/adt/pg_upgrade_support.c @@ -299,7 +299,7 @@ binary_upgrade_logical_slot_has_caught_up(PG_FUNCTION_ARGS) slot_name = PG_GETARG_NAME(0); /* Acquire the given slot */ - ReplicationSlotAcquire(NameStr(*slot_name), true); + ReplicationSlotAcquire(NameStr(*slot_name), true, false); Assert(SlotIsLogical(MyReplicationSlot)); @@ -310,7 +310,7 @@ binary_upgrade_logical_slot_has_caught_up(PG_FUNCTION_ARGS) found_pending_wal = LogicalReplicationSlotHasPendingWal(end_of_wal); /* Clean up */ - ReplicationSlotRelease(); + ReplicationSlotRelease(false); PG_RETURN_BOOL(!found_pending_wal); } diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 9cd4bf98e5..bd4ad48ce8 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -53,6 +53,8 @@ typedef enum ReplicationSlotInvalidationCause RS_INVAL_HORIZON, /* wal_level insufficient for slot */ RS_INVAL_WAL_LEVEL, + /* inactive slot timeout has occurred */ + RS_INVAL_INACTIVE_TIMEOUT, } ReplicationSlotInvalidationCause; extern PGDLLIMPORT const char *const SlotInvalidationCauses[]; @@ -249,8 +251,9 @@ extern void ReplicationSlotDropAcquired(void); extern void ReplicationSlotAlter(const char *name, bool failover, int inactive_timeout); -extern void ReplicationSlotAcquire(const char *name, bool nowait); -extern void ReplicationSlotRelease(void); +extern void ReplicationSlotAcquire(const char *name, bool nowait, + bool check_for_invalidation); +extern void ReplicationSlotRelease(bool set_last_inactive_at); extern void ReplicationSlotCleanup(void); extern void ReplicationSlotSave(void); extern void ReplicationSlotSaveToPath(ReplicationSlot *slot, const char *dir, @@ -270,6 +273,10 @@ extern bool InvalidateObsoleteReplicationSlots(ReplicationSlotInvalidationCause XLogSegNo oldestSegno, Oid dboid, TransactionId snapshotConflictHorizon); +extern bool InvalidateReplicationSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex, + bool persist_state); extern ReplicationSlot *SearchNamedReplicationSlot(const char *name, bool need_lock); extern int ReplicationSlotIndex(ReplicationSlot *slot); extern bool ReplicationSlotName(int index, Name name); diff --git a/src/test/recovery/meson.build b/src/test/recovery/meson.build index b1eb77b1ec..708a2a3798 100644 --- a/src/test/recovery/meson.build +++ b/src/test/recovery/meson.build @@ -51,6 +51,7 @@ tests += { 't/040_standby_failover_slots_sync.pl', 't/041_checkpoint_at_promote.pl', 't/042_low_level_backup.pl', + 't/050_invalidate_slots.pl', ], }, } diff --git a/src/test/recovery/t/050_invalidate_slots.pl b/src/test/recovery/t/050_invalidate_slots.pl new file mode 100644 index 0000000000..6adaa1d648 --- /dev/null +++ b/src/test/recovery/t/050_invalidate_slots.pl @@ -0,0 +1,170 @@ +# Copyright (c) 2024, PostgreSQL Global Development Group + +# Test for replication slots invalidation +use strict; +use warnings FATAL => 'all'; + +use PostgreSQL::Test::Utils; +use PostgreSQL::Test::Cluster; +use Test::More; +use Time::HiRes qw(usleep); + +# Check for invalidation of slot in server log. +sub check_slots_invalidation_in_server_log +{ + my ($node, $slot_name, $offset) = @_; + my $invalidated = 0; + + for (my $i = 0; $i < 10 * $PostgreSQL::Test::Utils::timeout_default; $i++) + { + $node->safe_psql('postgres', "CHECKPOINT"); + if ($node->log_contains( + "invalidating obsolete replication slot \"$slot_name\"", $offset)) + { + $invalidated = 1; + last; + } + usleep(100_000); + } + ok($invalidated, "check that slot $slot_name invalidation has been logged"); +} + +# ============================================================================= +# Testcase start: Invalidate streaming standby's slot due to inactive_timeout +# + +# Initialize primary node +my $primary = PostgreSQL::Test::Cluster->new('primary'); +$primary->init(allows_streaming => 'logical'); + +# Avoid checkpoint during the test, otherwise, the test can get unpredictable +$primary->append_conf( + 'postgresql.conf', q{ +checkpoint_timeout = 1h +autovacuum = off +}); +$primary->start; + +# Take backup +my $backup_name = 'my_backup'; +$primary->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby1 = PostgreSQL::Test::Cluster->new('standby1'); +$standby1->init_from_backup($primary, $backup_name, has_streaming => 1); +$standby1->append_conf( + 'postgresql.conf', q{ +primary_slot_name = 'sb1_slot' +}); + +# Set timeout so that the slot when inactive will get invalidated after the +# timeout. +my $inactive_timeout = 1; +$primary->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := 'sb1_slot', inactive_timeout := $inactive_timeout); +]); + +$standby1->start; + +# Wait until standby has replayed enough data +$primary->wait_for_catchup($standby1); + +# The inactive replication slot info should be null when the slot is active +my $result = $primary->safe_psql( + 'postgres', qq[ + SELECT last_inactive_at IS NULL, inactive_timeout = $inactive_timeout + FROM pg_replication_slots WHERE slot_name = 'sb1_slot'; +]); +is($result, "t|t", + 'check the inactive replication slot info for an active slot'); + +my $logstart = -s $primary->logfile; + +# Stop standby to make the replication slot on primary inactive +$standby1->stop; + +# Wait for the inactive replication slot info to be updated +$primary->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE last_inactive_at IS NOT NULL + AND slot_name = 'sb1_slot' + AND inactive_timeout = $inactive_timeout; +]) + or die + "Timed out while waiting for inactive replication slot info to be updated"; + +check_slots_invalidation_in_server_log($primary, 'sb1_slot', $logstart); + +# Wait for the inactive replication slots to be invalidated. +$primary->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE slot_name = 'sb1_slot' AND + invalidation_reason = 'inactive_timeout'; +]) + or die + "Timed out while waiting for inactive replication slot sb1_slot to be invalidated"; + +# Testcase end: Invalidate streaming standby's slot due to inactive_timeout +# ============================================================================= + +# ============================================================================= +# Testcase start: Invalidate logical subscriber's slot due to inactive_timeout +my $publisher = $primary; + +# Create subscriber node +my $subscriber = PostgreSQL::Test::Cluster->new('sub'); +$subscriber->init; +$subscriber->start; + +# Create tables +$publisher->safe_psql('postgres', "CREATE TABLE test_tbl (id int)"); +$subscriber->safe_psql('postgres', "CREATE TABLE test_tbl (id int)"); + +# Insert some data +$subscriber->safe_psql('postgres', + "INSERT INTO test_tbl VALUES (generate_series(1, 5));"); + +# Setup logical replication +my $publisher_connstr = $publisher->connstr . ' dbname=postgres'; +$publisher->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); +$subscriber->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher_connstr' PUBLICATION pub WITH (slot_name = 'lsub1_slot')" +); + +$subscriber->wait_for_subscription_sync($publisher, 'sub'); + +$result = $subscriber->safe_psql('postgres', "SELECT count(*) FROM test_tbl"); + +is($result, qq(5), "check initial copy was done"); + +# Alter slot to set inactive_timeout +$publisher->safe_psql( + 'postgres', qq[ + SELECT pg_alter_replication_slot(slot_name := 'lsub1_slot', inactive_timeout := $inactive_timeout); +]); + +$logstart = -s $publisher->logfile; + +# Stop subscriber to make the replication slot on publisher inactive +$subscriber->stop; + +# Wait for the inactive replication slot info to be updated +$publisher->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE last_inactive_at IS NOT NULL + AND slot_name = 'lsub1_slot' + AND inactive_timeout = $inactive_timeout; +]) + or die + "Timed out while waiting for inactive replication slot info to be updated"; + +check_slots_invalidation_in_server_log($publisher, 'lsub1_slot', $logstart); + +# Testcase end: Invalidate logical subscriber's slot due to inactive_timeout +# ============================================================================= + +done_testing(); -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 08:57 Bertrand Drouvot <[email protected]> parent: Bharath Rupireddy <[email protected]> 2 siblings, 1 reply; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-22 08:57 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > On Fri, Mar 22, 2024 at 12:39 PM Bertrand Drouvot > <[email protected]> wrote: > > > > > > Please find the v14-0001 patch for now. > > > > Thanks! > > > > > LGTM. Let's wait for Bertrand to see if he has more comments on 0001 > > > and then I'll push it. > > > > LGTM too. > > Thanks. Here I'm implementing the following: Thanks! > 0001 Track invalidation_reason in pg_replication_slots > 0002 Track last_inactive_at in pg_replication_slots > 0003 Allow setting inactive_timeout for replication slots via SQL API > 0004 Introduce new SQL funtion pg_alter_replication_slot > 0005 Allow setting inactive_timeout in the replication command > 0006 Add inactive_timeout based replication slot invalidation > > 1. Keep it last_inactive_at as a shared memory variable, but always > set it at restart if the slot's inactive_timeout has non-zero value > and reset it as soon as someone acquires that slot so that if the slot > doesn't get acquired till inactive_timeout, checkpointer will > invalidate the slot. > 4. last_inactive_at should also be set to the current time during slot > creation because if one creates a slot and does nothing with it then > it's the time it starts to be inactive. I did not look at the code yet but just tested the behavior. It works as you describe it but I think this behavior is weird because: - when we create a slot without a timeout then last_inactive_at is set. I think that's fine, but then: - when we restart the engine, then last_inactive_at is gone (as timeout is not set). I think last_inactive_at should be set also at engine restart even if there is no timeout. I don't think we should link both. Changing my mind here on this subject due to the testing. Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 09:29 Amit Kapila <[email protected]> parent: Bertrand Drouvot <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-22 09:29 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 2:27 PM Bertrand Drouvot <[email protected]> wrote: > > On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > > > 0001 Track invalidation_reason in pg_replication_slots > > 0002 Track last_inactive_at in pg_replication_slots > > 0003 Allow setting inactive_timeout for replication slots via SQL API > > 0004 Introduce new SQL funtion pg_alter_replication_slot > > 0005 Allow setting inactive_timeout in the replication command > > 0006 Add inactive_timeout based replication slot invalidation > > > > 1. Keep it last_inactive_at as a shared memory variable, but always > > set it at restart if the slot's inactive_timeout has non-zero value > > and reset it as soon as someone acquires that slot so that if the slot > > doesn't get acquired till inactive_timeout, checkpointer will > > invalidate the slot. > > 4. last_inactive_at should also be set to the current time during slot > > creation because if one creates a slot and does nothing with it then > > it's the time it starts to be inactive. > > I did not look at the code yet but just tested the behavior. It works as you > describe it but I think this behavior is weird because: > > - when we create a slot without a timeout then last_inactive_at is set. I think > that's fine, but then: > - when we restart the engine, then last_inactive_at is gone (as timeout is not > set). > > I think last_inactive_at should be set also at engine restart even if there is > no timeout. I think it is the opposite. Why do we need to set 'last_inactive_at' when inactive_timeout is not set? BTW, haven't we discussed that we don't need to set 'last_inactive_at' at the time of slot creation as it is sufficient to set it at the time ReplicationSlotRelease()? A few other comments: ================== 1. @@ -1027,7 +1027,8 @@ CREATE VIEW pg_replication_slots AS L.invalidation_reason, L.failover, L.synced, - L.last_inactive_at + L.last_inactive_at, + L.inactive_timeout I think it would be better to keep 'inactive_timeout' ahead of 'last_inactive_at' as that is the primary field. In major versions, we don't have to strictly keep the new fields at the end. In this case, it seems better to keep these two new fields after two_phase so that these are before invalidation_reason where we can show the invalidation due to these fields. 2. void -ReplicationSlotRelease(void) +ReplicationSlotRelease(bool set_last_inactive_at) Why do we need a parameter here? Can't we directly check from the slot whether 'inactive_timeout' has a non-zero value? 3. + /* + * There's no point in allowing failover slots to get invalidated + * based on slot's inactive_timeout parameter on standby. The failover + * slots simply get synced from the primary on the standby. + */ + if (!(RecoveryInProgress() && slot->data.failover)) I think you need to check 'sync' flag instead of 'failover'. Generally, failover marker slots should be invalidated either on primary or standby unless on standby the 'failover' marked slot is synced from the primary. 4. I feel the patches should be arranged like 0003->0001, 0002->0002, 0006->0003. We can leave remaining for the time being till we get these three patches (all three need to be committed as one but it is okay to keep them separate for review) committed. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 09:45 Bertrand Drouvot <[email protected]> parent: Bharath Rupireddy <[email protected]> 2 siblings, 2 replies; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-22 09:45 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > On Fri, Mar 22, 2024 at 12:39 PM Bertrand Drouvot > <[email protected]> wrote: > > > > > > Please find the v14-0001 patch for now. > > > > Thanks! > > > > > LGTM. Let's wait for Bertrand to see if he has more comments on 0001 > > > and then I'll push it. > > > > LGTM too. > > > Please see the attached v14 patch set. No change in the attached > v14-0001 from the previous patch. Looking at v14-0002: 1 === @@ -691,6 +699,13 @@ ReplicationSlotRelease(void) ConditionVariableBroadcast(&slot->active_cv); } + if (slot->data.persistency == RS_PERSISTENT) + { + SpinLockAcquire(&slot->mutex); + slot->last_inactive_at = GetCurrentTimestamp(); + SpinLockRelease(&slot->mutex); + } I'm not sure we should do system calls while we're holding a spinlock. Assign a variable before? 2 === Also, what about moving this here? " if (slot->data.persistency == RS_PERSISTENT) { /* * Mark persistent slot inactive. We're not freeing it, just * disconnecting, but wake up others that may be waiting for it. */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } " That would avoid testing twice "slot->data.persistency == RS_PERSISTENT". 3 === @@ -2341,6 +2356,7 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; + slot->last_inactive_at = 0; I think we should put GetCurrentTimestamp() here. It's done in v14-0006 but I think it's better to do it in 0002 (and not taking care of inactive_timeout). 4 === Track last_inactive_at in pg_replication_slots doc/src/sgml/system-views.sgml | 11 +++++++++++ src/backend/catalog/system_views.sql | 3 ++- src/backend/replication/slot.c | 16 ++++++++++++++++ src/backend/replication/slotfuncs.c | 7 ++++++- src/include/catalog/pg_proc.dat | 6 +++--- src/include/replication/slot.h | 3 +++ src/test/regress/expected/rules.out | 5 +++-- 7 files changed, 44 insertions(+), 7 deletions(-) Worth to add some tests too (or we postpone them in future commits because we're confident enough they will follow soon)? 5 === Most of the fields that reflect a time (not duration) in the system views are xxxx_time, so I'm wondering if instead of "last_inactive_at" we should use something like "last_inactive_time"? Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 09:53 Bertrand Drouvot <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-22 09:53 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Fri, Mar 22, 2024 at 02:59:21PM +0530, Amit Kapila wrote: > On Fri, Mar 22, 2024 at 2:27 PM Bertrand Drouvot > <[email protected]> wrote: > > > > On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > > > > > 0001 Track invalidation_reason in pg_replication_slots > > > 0002 Track last_inactive_at in pg_replication_slots > > > 0003 Allow setting inactive_timeout for replication slots via SQL API > > > 0004 Introduce new SQL funtion pg_alter_replication_slot > > > 0005 Allow setting inactive_timeout in the replication command > > > 0006 Add inactive_timeout based replication slot invalidation > > > > > > 1. Keep it last_inactive_at as a shared memory variable, but always > > > set it at restart if the slot's inactive_timeout has non-zero value > > > and reset it as soon as someone acquires that slot so that if the slot > > > doesn't get acquired till inactive_timeout, checkpointer will > > > invalidate the slot. > > > 4. last_inactive_at should also be set to the current time during slot > > > creation because if one creates a slot and does nothing with it then > > > it's the time it starts to be inactive. > > > > I did not look at the code yet but just tested the behavior. It works as you > > describe it but I think this behavior is weird because: > > > > - when we create a slot without a timeout then last_inactive_at is set. I think > > that's fine, but then: > > - when we restart the engine, then last_inactive_at is gone (as timeout is not > > set). > > > > I think last_inactive_at should be set also at engine restart even if there is > > no timeout. > > I think it is the opposite. Why do we need to set 'last_inactive_at' > when inactive_timeout is not set? I think those are unrelated, one could want to know when a slot has been inactive even if no timeout is set. I understand that for this patch series we have in mind to use them both to invalidate slots but I think that there is use case to not use both in correlation. Also not setting last_inactive_at could give the "false" impression that the slot is active. > BTW, haven't we discussed that we > don't need to set 'last_inactive_at' at the time of slot creation as > it is sufficient to set it at the time ReplicationSlotRelease()? Right. Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 10:26 Amit Kapila <[email protected]> parent: Bertrand Drouvot <[email protected]> 1 sibling, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-22 10:26 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 3:15 PM Bertrand Drouvot <[email protected]> wrote: > > On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > > 1 === > > @@ -691,6 +699,13 @@ ReplicationSlotRelease(void) > ConditionVariableBroadcast(&slot->active_cv); > } > > + if (slot->data.persistency == RS_PERSISTENT) > + { > + SpinLockAcquire(&slot->mutex); > + slot->last_inactive_at = GetCurrentTimestamp(); > + SpinLockRelease(&slot->mutex); > + } > > I'm not sure we should do system calls while we're holding a spinlock. > Assign a variable before? > > 2 === > > Also, what about moving this here? > > " > if (slot->data.persistency == RS_PERSISTENT) > { > /* > * Mark persistent slot inactive. We're not freeing it, just > * disconnecting, but wake up others that may be waiting for it. > */ > SpinLockAcquire(&slot->mutex); > slot->active_pid = 0; > SpinLockRelease(&slot->mutex); > ConditionVariableBroadcast(&slot->active_cv); > } > " > > That would avoid testing twice "slot->data.persistency == RS_PERSISTENT". > That sounds like a good idea. Also, don't we need to consider physical slots where we don't reserve WAL during slot creation? I don't think there is a need to set inactive_at for such slots. If we agree, probably checking restart_lsn should suffice the need to know whether the WAL is reserved or not. > > 5 === > > Most of the fields that reflect a time (not duration) in the system views are > xxxx_time, so I'm wondering if instead of "last_inactive_at" we should use > something like "last_inactive_time"? > How about naming it as last_active_time? This will indicate the time at which the slot was last active. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 10:46 Amit Kapila <[email protected]> parent: Bertrand Drouvot <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-22 10:46 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 3:23 PM Bertrand Drouvot <[email protected]> wrote: > > On Fri, Mar 22, 2024 at 02:59:21PM +0530, Amit Kapila wrote: > > On Fri, Mar 22, 2024 at 2:27 PM Bertrand Drouvot > > <[email protected]> wrote: > > > > > > On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > > > > > > > 0001 Track invalidation_reason in pg_replication_slots > > > > 0002 Track last_inactive_at in pg_replication_slots > > > > 0003 Allow setting inactive_timeout for replication slots via SQL API > > > > 0004 Introduce new SQL funtion pg_alter_replication_slot > > > > 0005 Allow setting inactive_timeout in the replication command > > > > 0006 Add inactive_timeout based replication slot invalidation > > > > > > > > 1. Keep it last_inactive_at as a shared memory variable, but always > > > > set it at restart if the slot's inactive_timeout has non-zero value > > > > and reset it as soon as someone acquires that slot so that if the slot > > > > doesn't get acquired till inactive_timeout, checkpointer will > > > > invalidate the slot. > > > > 4. last_inactive_at should also be set to the current time during slot > > > > creation because if one creates a slot and does nothing with it then > > > > it's the time it starts to be inactive. > > > > > > I did not look at the code yet but just tested the behavior. It works as you > > > describe it but I think this behavior is weird because: > > > > > > - when we create a slot without a timeout then last_inactive_at is set. I think > > > that's fine, but then: > > > - when we restart the engine, then last_inactive_at is gone (as timeout is not > > > set). > > > > > > I think last_inactive_at should be set also at engine restart even if there is > > > no timeout. > > > > I think it is the opposite. Why do we need to set 'last_inactive_at' > > when inactive_timeout is not set? > > I think those are unrelated, one could want to know when a slot has been inactive > even if no timeout is set. I understand that for this patch series we have in mind > to use them both to invalidate slots but I think that there is use case to not > use both in correlation. Also not setting last_inactive_at could give the "false" > impression that the slot is active. > I see your point and agree with this. I feel we can commit this part first then, probably that is the reason Bharath has kept it as a separate patch. It would be good add the use case for this patch in the commit message. A minor comment: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); + if (s->data.persistency == RS_PERSISTENT) + { + SpinLockAcquire(&s->mutex); + s->last_inactive_at = 0; + SpinLockRelease(&s->mutex); + } + I think this part of the change needs a comment. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 12:00 Bertrand Drouvot <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-22 12:00 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Fri, Mar 22, 2024 at 03:56:23PM +0530, Amit Kapila wrote: > On Fri, Mar 22, 2024 at 3:15 PM Bertrand Drouvot > <[email protected]> wrote: > > > > On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > > > > 1 === > > > > @@ -691,6 +699,13 @@ ReplicationSlotRelease(void) > > ConditionVariableBroadcast(&slot->active_cv); > > } > > > > + if (slot->data.persistency == RS_PERSISTENT) > > + { > > + SpinLockAcquire(&slot->mutex); > > + slot->last_inactive_at = GetCurrentTimestamp(); > > + SpinLockRelease(&slot->mutex); > > + } > > > > I'm not sure we should do system calls while we're holding a spinlock. > > Assign a variable before? > > > > 2 === > > > > Also, what about moving this here? > > > > " > > if (slot->data.persistency == RS_PERSISTENT) > > { > > /* > > * Mark persistent slot inactive. We're not freeing it, just > > * disconnecting, but wake up others that may be waiting for it. > > */ > > SpinLockAcquire(&slot->mutex); > > slot->active_pid = 0; > > SpinLockRelease(&slot->mutex); > > ConditionVariableBroadcast(&slot->active_cv); > > } > > " > > > > That would avoid testing twice "slot->data.persistency == RS_PERSISTENT". > > > > That sounds like a good idea. Also, don't we need to consider physical > slots where we don't reserve WAL during slot creation? I don't think > there is a need to set inactive_at for such slots. If the slot is not active, why shouldn't we set inactive_at? I can understand that such a slots do not present "any risks" but I think we should still set inactive_at (also to not give the false impression that the slot is active). > > 5 === > > > > Most of the fields that reflect a time (not duration) in the system views are > > xxxx_time, so I'm wondering if instead of "last_inactive_at" we should use > > something like "last_inactive_time"? > > > > How about naming it as last_active_time? This will indicate the time > at which the slot was last active. I thought about it too but I think it could be missleading as one could think that it should be updated each time WAL record decoding is happening. Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 12:03 Bertrand Drouvot <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 0 replies; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-22 12:03 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Fri, Mar 22, 2024 at 04:16:19PM +0530, Amit Kapila wrote: > On Fri, Mar 22, 2024 at 3:23 PM Bertrand Drouvot > <[email protected]> wrote: > > > > On Fri, Mar 22, 2024 at 02:59:21PM +0530, Amit Kapila wrote: > > > On Fri, Mar 22, 2024 at 2:27 PM Bertrand Drouvot > > > <[email protected]> wrote: > > > > > > > > On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > > > > > > > > > 0001 Track invalidation_reason in pg_replication_slots > > > > > 0002 Track last_inactive_at in pg_replication_slots > > > > > 0003 Allow setting inactive_timeout for replication slots via SQL API > > > > > 0004 Introduce new SQL funtion pg_alter_replication_slot > > > > > 0005 Allow setting inactive_timeout in the replication command > > > > > 0006 Add inactive_timeout based replication slot invalidation > > > > > > > > > > 1. Keep it last_inactive_at as a shared memory variable, but always > > > > > set it at restart if the slot's inactive_timeout has non-zero value > > > > > and reset it as soon as someone acquires that slot so that if the slot > > > > > doesn't get acquired till inactive_timeout, checkpointer will > > > > > invalidate the slot. > > > > > 4. last_inactive_at should also be set to the current time during slot > > > > > creation because if one creates a slot and does nothing with it then > > > > > it's the time it starts to be inactive. > > > > > > > > I did not look at the code yet but just tested the behavior. It works as you > > > > describe it but I think this behavior is weird because: > > > > > > > > - when we create a slot without a timeout then last_inactive_at is set. I think > > > > that's fine, but then: > > > > - when we restart the engine, then last_inactive_at is gone (as timeout is not > > > > set). > > > > > > > > I think last_inactive_at should be set also at engine restart even if there is > > > > no timeout. > > > > > > I think it is the opposite. Why do we need to set 'last_inactive_at' > > > when inactive_timeout is not set? > > > > I think those are unrelated, one could want to know when a slot has been inactive > > even if no timeout is set. I understand that for this patch series we have in mind > > to use them both to invalidate slots but I think that there is use case to not > > use both in correlation. Also not setting last_inactive_at could give the "false" > > impression that the slot is active. > > > > I see your point and agree with this. I feel we can commit this part > first then, Agree that in this case the current ordering makes sense (as setting last_inactive_at would be completly unrelated to the timeout). Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 12:24 Ajin Cherian <[email protected]> parent: Bharath Rupireddy <[email protected]> 2 siblings, 0 replies; 43+ messages in thread From: Ajin Cherian @ 2024-03-22 12:24 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 7:15 PM Bharath Rupireddy < [email protected]> wrote: > On Fri, Mar 22, 2024 at 12:39 PM Bertrand Drouvot > <[email protected]> wrote: > > > > > > Please find the v14-0001 patch for now. > > > > Thanks! > > > > > LGTM. Let's wait for Bertrand to see if he has more comments on 0001 > > > and then I'll push it. > > > > LGTM too. > > Thanks. Here I'm implementing the following: > > 0001 Track invalidation_reason in pg_replication_slots > 0002 Track last_inactive_at in pg_replication_slots > 0003 Allow setting inactive_timeout for replication slots via SQL API > 0004 Introduce new SQL funtion pg_alter_replication_slot > 0005 Allow setting inactive_timeout in the replication command > 0006 Add inactive_timeout based replication slot invalidation > > 1. Keep it last_inactive_at as a shared memory variable, but always > set it at restart if the slot's inactive_timeout has non-zero value > and reset it as soon as someone acquires that slot so that if the slot > doesn't get acquired till inactive_timeout, checkpointer will > invalidate the slot. > 2. Ensure with pg_alter_replication_slot one could "only" alter the > timeout property for the time being, if not that could lead to the > subscription inconsistency. > 3. Have some notes in the CREATE and ALTER SUBSCRIPTION docs about > using an existing slot to leverage inactive_timeout feature. > 4. last_inactive_at should also be set to the current time during slot > creation because if one creates a slot and does nothing with it then > it's the time it starts to be inactive. > 5. We don't set last_inactive_at to GetCurrentTimestamp() for failover > slots. > 6. Leave the patch that added support for inactive_timeout in > subscriptions. > > Please see the attached v14 patch set. No change in the attached > v14-0001 from the previous patch. > > > Some comments: 1. In patch 0005: In ReplicationSlotAlter(): + lock_acquired = false; if (MyReplicationSlot->data.failover != failover) { SpinLockAcquire(&MyReplicationSlot->mutex); + lock_acquired = true; MyReplicationSlot->data.failover = failover; + } + + if (MyReplicationSlot->data.inactive_timeout != inactive_timeout) + { + if (!lock_acquired) + { + SpinLockAcquire(&MyReplicationSlot->mutex); + lock_acquired = true; + } + + MyReplicationSlot->data.inactive_timeout = inactive_timeout; + } + + if (lock_acquired) + { SpinLockRelease(&MyReplicationSlot->mutex); Can't you make it shorter like below: lock_acquired = false; if (MyReplicationSlot->data.failover != failover || MyReplicationSlot->data.inactive_timeout != inactive_timeout) { SpinLockAcquire(&MyReplicationSlot->mutex); lock_acquired = true; } if (MyReplicationSlot->data.failover != failover) { MyReplicationSlot->data.failover = failover; } if (MyReplicationSlot->data.inactive_timeout != inactive_timeout) { MyReplicationSlot->data.inactive_timeout = inactive_timeout; } if (lock_acquired) { SpinLockRelease(&MyReplicationSlot->mutex); ReplicationSlotMarkDirty(); ReplicationSlotSave(); } 2. In patch 0005: why change walrcv_alter_slot option? it doesn't seem to be used anywhere, any use case for it? If required, would the intention be to add this as a Create Subscription option? regards, Ajin Cherian Fujitsu Australia ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 12:32 Amit Kapila <[email protected]> parent: Bertrand Drouvot <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-22 12:32 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 5:30 PM Bertrand Drouvot <[email protected]> wrote: > > On Fri, Mar 22, 2024 at 03:56:23PM +0530, Amit Kapila wrote: > > On Fri, Mar 22, 2024 at 3:15 PM Bertrand Drouvot > > <[email protected]> wrote: > > > > > > On Fri, Mar 22, 2024 at 01:45:01PM +0530, Bharath Rupireddy wrote: > > > > > > 1 === > > > > > > @@ -691,6 +699,13 @@ ReplicationSlotRelease(void) > > > ConditionVariableBroadcast(&slot->active_cv); > > > } > > > > > > + if (slot->data.persistency == RS_PERSISTENT) > > > + { > > > + SpinLockAcquire(&slot->mutex); > > > + slot->last_inactive_at = GetCurrentTimestamp(); > > > + SpinLockRelease(&slot->mutex); > > > + } > > > > > > I'm not sure we should do system calls while we're holding a spinlock. > > > Assign a variable before? > > > > > > 2 === > > > > > > Also, what about moving this here? > > > > > > " > > > if (slot->data.persistency == RS_PERSISTENT) > > > { > > > /* > > > * Mark persistent slot inactive. We're not freeing it, just > > > * disconnecting, but wake up others that may be waiting for it. > > > */ > > > SpinLockAcquire(&slot->mutex); > > > slot->active_pid = 0; > > > SpinLockRelease(&slot->mutex); > > > ConditionVariableBroadcast(&slot->active_cv); > > > } > > > " > > > > > > That would avoid testing twice "slot->data.persistency == RS_PERSISTENT". > > > > > > > That sounds like a good idea. Also, don't we need to consider physical > > slots where we don't reserve WAL during slot creation? I don't think > > there is a need to set inactive_at for such slots. > > If the slot is not active, why shouldn't we set inactive_at? I can understand > that such a slots do not present "any risks" but I think we should still set > inactive_at (also to not give the false impression that the slot is active). > But OTOH, there is a chance that we will invalidate such slots even though they have never reserved WAL in the first place which doesn't appear to be a good thing. > > > 5 === > > > > > > Most of the fields that reflect a time (not duration) in the system views are > > > xxxx_time, so I'm wondering if instead of "last_inactive_at" we should use > > > something like "last_inactive_time"? > > > > > > > How about naming it as last_active_time? This will indicate the time > > at which the slot was last active. > > I thought about it too but I think it could be missleading as one could think that > it should be updated each time WAL record decoding is happening. > Fair enough. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 13:47 Bertrand Drouvot <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-22 13:47 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Fri, Mar 22, 2024 at 06:02:11PM +0530, Amit Kapila wrote: > On Fri, Mar 22, 2024 at 5:30 PM Bertrand Drouvot > <[email protected]> wrote: > > On Fri, Mar 22, 2024 at 03:56:23PM +0530, Amit Kapila wrote: > > > > > > > > That would avoid testing twice "slot->data.persistency == RS_PERSISTENT". > > > > > > > > > > That sounds like a good idea. Also, don't we need to consider physical > > > slots where we don't reserve WAL during slot creation? I don't think > > > there is a need to set inactive_at for such slots. > > > > If the slot is not active, why shouldn't we set inactive_at? I can understand > > that such a slots do not present "any risks" but I think we should still set > > inactive_at (also to not give the false impression that the slot is active). > > > > But OTOH, there is a chance that we will invalidate such slots even > though they have never reserved WAL in the first place which doesn't > appear to be a good thing. That's right but I don't think it is not a good thing. I think we should treat inactive_at as an independent field (like if the timeout one does not exist at all) and just focus on its meaning (slot being inactive). If one sets a timeout (> 0) and gets an invalidation then I think it works as designed (even if the slot does not present any "risk" as it does not hold any rows or WAL). Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-22 21:32 Bharath Rupireddy <[email protected]> parent: Bertrand Drouvot <[email protected]> 1 sibling, 1 reply; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-22 21:32 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 3:15 PM Bertrand Drouvot <[email protected]> wrote: > > Looking at v14-0002: Thanks for reviewing. I agree that 0002 with last_inactive_at can go independently and be of use on its own in addition to helping implement inactive_timeout based invalidation. > 1 === > > @@ -691,6 +699,13 @@ ReplicationSlotRelease(void) > ConditionVariableBroadcast(&slot->active_cv); > } > > + if (slot->data.persistency == RS_PERSISTENT) > + { > + SpinLockAcquire(&slot->mutex); > + slot->last_inactive_at = GetCurrentTimestamp(); > + SpinLockRelease(&slot->mutex); > + } > > I'm not sure we should do system calls while we're holding a spinlock. > Assign a variable before? Can do that. Then, the last_inactive_at = current_timestamp + mutex acquire time. But, that shouldn't be a problem than doing system calls while holding the mutex. So, done that way. > 2 === > > Also, what about moving this here? > > " > if (slot->data.persistency == RS_PERSISTENT) > { > /* > * Mark persistent slot inactive. We're not freeing it, just > * disconnecting, but wake up others that may be waiting for it. > */ > SpinLockAcquire(&slot->mutex); > slot->active_pid = 0; > SpinLockRelease(&slot->mutex); > ConditionVariableBroadcast(&slot->active_cv); > } > " > > That would avoid testing twice "slot->data.persistency == RS_PERSISTENT". Ugh. Done that now. > 3 === > > @@ -2341,6 +2356,7 @@ RestoreSlotFromDisk(const char *name) > > slot->in_use = true; > slot->active_pid = 0; > + slot->last_inactive_at = 0; > > I think we should put GetCurrentTimestamp() here. It's done in v14-0006 but I > think it's better to do it in 0002 (and not taking care of inactive_timeout). Done. > 4 === > > Track last_inactive_at in pg_replication_slots > > doc/src/sgml/system-views.sgml | 11 +++++++++++ > src/backend/catalog/system_views.sql | 3 ++- > src/backend/replication/slot.c | 16 ++++++++++++++++ > src/backend/replication/slotfuncs.c | 7 ++++++- > src/include/catalog/pg_proc.dat | 6 +++--- > src/include/replication/slot.h | 3 +++ > src/test/regress/expected/rules.out | 5 +++-- > 7 files changed, 44 insertions(+), 7 deletions(-) > > Worth to add some tests too (or we postpone them in future commits because we're > confident enough they will follow soon)? Yes. Added some tests in a new TAP test file named src/test/recovery/t/043_replslot_misc.pl. This new file can be used to add miscellaneous replication tests in future as well. I couldn't find a better place in existing test files - tried having the new tests for physical slots in t/001_stream_rep.pl and I didn't find a right place for logical slots. > 5 === > > Most of the fields that reflect a time (not duration) in the system views are > xxxx_time, so I'm wondering if instead of "last_inactive_at" we should use > something like "last_inactive_time"? Yeah, I can see that. So, I changed it to last_inactive_time. I agree with treating last_inactive_time as a separate property of the slot having its own use in addition to helping implement inactive_timeout based invalidation. I think it can go separately. I tried to address the review comments received for this patch alone and attached v15-0001. I'll post other patches soon. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/octet-stream] v15-0001-Track-last_inactive_time-in-pg_replication_slots.patch (13.7K, ../../CALj2ACVUCo48FXWAcxC9LEV6P=xgd-8O=e9aPmTRUZvvH_L7Zw@mail.gmail.com/2-v15-0001-Track-last_inactive_time-in-pg_replication_slots.patch) download | inline diff: From 239db578c1c84f264b60190078784a5b4f781c0b Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Fri, 22 Mar 2024 21:07:46 +0000 Subject: [PATCH v15] Track last_inactive_time in pg_replication_slots. Till now, the time at which the replication slot became inactive is not tracked directly in pg_replication_slots. This commit adds a new column 'last_inactive_time' for that for persistent slots. It is set to 0 whenever a slot is made active/acquired and set to current timestamp whenever the slot is inactive/released. The new column will be useful on production servers to debug and analyze inactive replication slots. It will also help to know the lifetime of a replication slot - one can know how long a streaming standby, logical subscriber, or replication slot consumer is down. The new column will be useful to implement inactive timeout based replication slot invalidation in a future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/system-views.sgml | 11 +++ src/backend/catalog/system_views.sql | 3 +- src/backend/replication/slot.c | 33 +++++++ src/backend/replication/slotfuncs.c | 7 +- src/include/catalog/pg_proc.dat | 6 +- src/include/replication/slot.h | 3 + src/test/recovery/meson.build | 1 + src/test/recovery/t/043_replslot_misc.pl | 119 +++++++++++++++++++++++ src/test/regress/expected/rules.out | 5 +- 9 files changed, 181 insertions(+), 7 deletions(-) create mode 100644 src/test/recovery/t/043_replslot_misc.pl diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index b5da476c20..2628aaa4db 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2592,6 +2592,17 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>last_inactive_time</structfield> <type>timestamptz</type> + </para> + <para> + The time at which the slot became inactive. + <literal>NULL</literal> if the slot is currently actively being + used or if this is a temporary replication slot. + </para></entry> + </row> + </tbody> </tgroup> </table> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index f69b7f5580..1bb350cc3c 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1026,7 +1026,8 @@ CREATE VIEW pg_replication_slots AS L.conflicting, L.invalidation_reason, L.failover, - L.synced + L.synced, + L.last_inactive_time FROM pg_get_replication_slots() AS L LEFT JOIN pg_database D ON (L.datoid = D.oid); diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index cdf0c450c5..643acc3f05 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,6 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; + slot->last_inactive_time = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -622,6 +623,17 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); + /* + * The slot is active by now, so reset the last inactive time. We don't + * track the last inactive time for non-persistent slots. + */ + if (s->data.persistency == RS_PERSISTENT) + { + SpinLockAcquire(&s->mutex); + s->last_inactive_time = 0; + SpinLockRelease(&s->mutex); + } + if (am_walsender) { ereport(log_replication_commands ? LOG : DEBUG1, @@ -681,12 +693,23 @@ ReplicationSlotRelease(void) if (slot->data.persistency == RS_PERSISTENT) { + TimestampTz now; + + /* + * Get current time beforehand to avoid system call while holding the + * lock. + */ + now = GetCurrentTimestamp(); + /* * Mark persistent slot inactive. We're not freeing it, just * disconnecting, but wake up others that may be waiting for it. + * + * We don't track the last inactive time for non-persistent slots. */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; + slot->last_inactive_time = now; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } @@ -2342,6 +2365,16 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; + /* + * We set last inactive time after loading the slot from the disk into + * memory. Whoever acquires the slot i.e. makes the slot active will + * anyway reset it. + * + * Note that we don't need the slot's persistency check here because + * non-persistent slots don't get saved to disk at all. + */ + slot->last_inactive_time = GetCurrentTimestamp(); + restored = true; break; } diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 4232c1e52e..d115fa88ce 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 18 +#define PG_GET_REPLICATION_SLOTS_COLS 19 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -436,6 +436,11 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.synced); + if (slot_contents.last_inactive_time > 0) + values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_time); + else + nulls[i++] = true; + Assert(i == PG_GET_REPLICATION_SLOTS_COLS); tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 71c74350a0..96adf6c5b0 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool,timestamptz}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced,last_inactive_time}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 7f25a083ee..2f18433ecc 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -201,6 +201,9 @@ typedef struct ReplicationSlot * forcibly flushed or not. */ XLogRecPtr last_saved_confirmed_flush; + + /* The time at which this slot become inactive */ + TimestampTz last_inactive_time; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/recovery/meson.build b/src/test/recovery/meson.build index b1eb77b1ec..c8259f99d5 100644 --- a/src/test/recovery/meson.build +++ b/src/test/recovery/meson.build @@ -51,6 +51,7 @@ tests += { 't/040_standby_failover_slots_sync.pl', 't/041_checkpoint_at_promote.pl', 't/042_low_level_backup.pl', + 't/043_replslot_misc.pl', ], }, } diff --git a/src/test/recovery/t/043_replslot_misc.pl b/src/test/recovery/t/043_replslot_misc.pl new file mode 100644 index 0000000000..bdaaa8bce8 --- /dev/null +++ b/src/test/recovery/t/043_replslot_misc.pl @@ -0,0 +1,119 @@ +# Copyright (c) 2024, PostgreSQL Global Development Group + +# Replication slot related miscellaneous tests +use strict; +use warnings FATAL => 'all'; +use PostgreSQL::Test::Cluster; +use PostgreSQL::Test::Utils; +use Test::More; + +# ============================================================================= +# Testcase start: Check last_inactive_time property of streaming standby's slot +# + +# Initialize primary node +my $primary = PostgreSQL::Test::Cluster->new('primary'); +$primary->init(allows_streaming => 'logical'); +$primary->start; + +# Take backup +my $backup_name = 'my_backup'; +$primary->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby = PostgreSQL::Test::Cluster->new('standby'); +$standby->init_from_backup($primary, $backup_name, has_streaming => 1); + +my $sb_slot = 'sb_slot'; +$standby->append_conf('postgresql.conf', "primary_slot_name = '$sb_slot'"); + +$primary->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := '$sb_slot'); +]); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the standby below. +my $last_inactive_time_1 = $primary->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;) +); + +$standby->start; + +# Wait until standby has replayed enough data +$primary->wait_for_catchup($standby); + +# Now the slot is active so last_inactive_time value must be NULL +is( $primary->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$sb_slot';] + ), + 't', + 'last inactive time for an active physical slot is NULL'); + +# Stop the standby to check its last_inactive_time value is updated +$standby->stop; + +is( $primary->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time_1'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive physical slot is updated correctly'); + +# Testcase end: Check last_inactive_time property of streaming standby's slot +# ============================================================================= + +# ============================================================================= +# Testcase start: Check last_inactive_time property of logical subscriber's slot +my $publisher = $primary; + +# Create subscriber node +my $subscriber = PostgreSQL::Test::Cluster->new('sub'); +$subscriber->init; + +# Setup logical replication +my $publisher_connstr = $publisher->connstr . ' dbname=postgres'; +$publisher->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); + +my $lsub_slot = 'lsub_slot'; +$publisher->safe_psql('postgres', + "SELECT pg_create_logical_replication_slot(slot_name := '$lsub_slot', plugin := 'pgoutput');" +); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the subscriber below. +$last_inactive_time_1 = $primary->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$lsub_slot' AND last_inactive_time IS NOT NULL;) +); + +$subscriber->start; +$subscriber->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher_connstr' PUBLICATION pub WITH (slot_name = '$lsub_slot', create_slot = false)" +); + +# Wait until subscriber has caught up +$subscriber->wait_for_subscription_sync($publisher, 'sub'); + +# Now the slot is active so last_inactive_time value must be NULL +is( $publisher->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub_slot';] + ), + 't', + 'last inactive time for an active logical slot is NULL'); + +# Stop the subscriber to check its last_inactive_time value is updated +$subscriber->stop; + +is( $publisher->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time_1'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive logical slot is updated correctly'); + +# Testcase end: Check last_inactive_time property of logical subscriber's slot +# ============================================================================= + +done_testing(); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 18829ea586..c2110e984d 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1476,8 +1476,9 @@ pg_replication_slots| SELECT l.slot_name, l.conflicting, l.invalidation_reason, l.failover, - l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) + l.synced, + l.last_inactive_time + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced, last_inactive_time) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-23 05:06 Amit Kapila <[email protected]> parent: Bertrand Drouvot <[email protected]> 0 siblings, 0 replies; 43+ messages in thread From: Amit Kapila @ 2024-03-23 05:06 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Mar 22, 2024 at 7:17 PM Bertrand Drouvot <[email protected]> wrote: > > On Fri, Mar 22, 2024 at 06:02:11PM +0530, Amit Kapila wrote: > > On Fri, Mar 22, 2024 at 5:30 PM Bertrand Drouvot > > <[email protected]> wrote: > > > On Fri, Mar 22, 2024 at 03:56:23PM +0530, Amit Kapila wrote: > > > > > > > > > > That would avoid testing twice "slot->data.persistency == RS_PERSISTENT". > > > > > > > > > > > > > That sounds like a good idea. Also, don't we need to consider physical > > > > slots where we don't reserve WAL during slot creation? I don't think > > > > there is a need to set inactive_at for such slots. > > > > > > If the slot is not active, why shouldn't we set inactive_at? I can understand > > > that such a slots do not present "any risks" but I think we should still set > > > inactive_at (also to not give the false impression that the slot is active). > > > > > > > But OTOH, there is a chance that we will invalidate such slots even > > though they have never reserved WAL in the first place which doesn't > > appear to be a good thing. > > That's right but I don't think it is not a good thing. I think we should treat > inactive_at as an independent field (like if the timeout one does not exist at > all) and just focus on its meaning (slot being inactive). If one sets a timeout > (> 0) and gets an invalidation then I think it works as designed (even if the > slot does not present any "risk" as it does not hold any rows or WAL). > Fair point. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-23 05:57 Amit Kapila <[email protected]> parent: Bharath Rupireddy <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-23 05:57 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Sat, Mar 23, 2024 at 3:02 AM Bharath Rupireddy <[email protected]> wrote: > > On Fri, Mar 22, 2024 at 3:15 PM Bertrand Drouvot > <[email protected]> wrote: > > > > > > Worth to add some tests too (or we postpone them in future commits because we're > > confident enough they will follow soon)? > > Yes. Added some tests in a new TAP test file named > src/test/recovery/t/043_replslot_misc.pl. This new file can be used to > add miscellaneous replication tests in future as well. I couldn't find > a better place in existing test files - tried having the new tests for > physical slots in t/001_stream_rep.pl and I didn't find a right place > for logical slots. > How about adding the test in 019_replslot_limit? It is not a direct fit but I feel later we can even add 'invalid_timeout' related tests in this file which will use last_inactive_time feature. It is also possible that some of the tests added by the 'invalid_timeout' feature will obviate the need for some of these tests. Review of v15 ============== 1. @@ -1026,7 +1026,8 @@ CREATE VIEW pg_replication_slots AS L.conflicting, L.invalidation_reason, L.failover, - L.synced + L.synced, + L.last_inactive_time FROM pg_get_replication_slots() AS L As mentioned previously, let's keep these new fields before conflicting and after two_phase. 2. +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the standby below. +my $last_inactive_time_1 = $primary->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;) +); We should check $last_inactive_time_1 to be a valid value and add a similar check for logical slots. 3. BTW, why don't we set last_inactive_time for temporary slots (RS_TEMPORARY) as well? Don't we even invalidate temporary slots? If so, then I think we should set last_inactive_time for those as well and later allow them to be invalidated based on timeout parameter. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-23 07:41 Bharath Rupireddy <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 2 replies; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-23 07:41 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Sat, Mar 23, 2024 at 11:27 AM Amit Kapila <[email protected]> wrote: > > How about adding the test in 019_replslot_limit? It is not a direct > fit but I feel later we can even add 'invalid_timeout' related tests > in this file which will use last_inactive_time feature. I'm thinking the other way. Now, the new TAP file 043_replslot_misc.pl can have last_inactive_time tests, and later invalid_timeout ones too. This way 019_replslot_limit.pl is not cluttered. > It is also > possible that some of the tests added by the 'invalid_timeout' feature > will obviate the need for some of these tests. Might be. But, I prefer to keep both these tests separate but in the same file 043_replslot_misc.pl. Because we cover some corner cases the last_inactive_time is set upon loading the slot from disk. > Review of v15 > ============== > 1. > @@ -1026,7 +1026,8 @@ CREATE VIEW pg_replication_slots AS > L.conflicting, > L.invalidation_reason, > L.failover, > - L.synced > + L.synced, > + L.last_inactive_time > FROM pg_get_replication_slots() AS L > > As mentioned previously, let's keep these new fields before > conflicting and after two_phase. Sorry, I forgot to notice that comment (out of a flood of comments really :)). Now, done that way. > 2. > +# Get last_inactive_time value after slot's creation. Note that the > slot is still > +# inactive unless it's used by the standby below. > +my $last_inactive_time_1 = $primary->safe_psql('postgres', > + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE > slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;) > +); > > We should check $last_inactive_time_1 to be a valid value and add a > similar check for logical slots. That's taken care by the type cast we do, right? Isn't that enough? is( $primary->safe_psql( 'postgres', qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;] ), 't', 'last inactive time for an inactive physical slot is updated correctly'); For instance, setting last_inactive_time_1 to an invalid value fails with the following error: error running SQL: 'psql:<stdin>:1: ERROR: invalid input syntax for type timestamp with time zone: "foo" LINE 1: SELECT last_inactive_time > 'foo'::timestamptz FROM pg_repli... > 3. BTW, why don't we set last_inactive_time for temporary slots > (RS_TEMPORARY) as well? Don't we even invalidate temporary slots? If > so, then I think we should set last_inactive_time for those as well > and later allow them to be invalidated based on timeout parameter. WFM. Done that way. Please see the attached v16 patch. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/x-patch] v16-0001-Track-last_inactive_time-in-pg_replication_slots.patch (14.1K, ../../CALj2ACXQmGx-L073=8CUSOk3hhe=HL_e6dveYeR9WJcEh+7jvg@mail.gmail.com/2-v16-0001-Track-last_inactive_time-in-pg_replication_slots.patch) download | inline diff: From ce85a48bbbd9de5d6ca0ce849993707cc01d1211 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Sat, 23 Mar 2024 07:27:48 +0000 Subject: [PATCH v16] Track last_inactive_time in pg_replication_slots. Till now, the time at which the replication slot became inactive is not tracked directly in pg_replication_slots. This commit adds a new column 'last_inactive_time' for this. It is set to 0 whenever a slot is made active/acquired and set to current timestamp whenever the slot is inactive/released or restored from the disk. The new column will be useful on production servers to debug and analyze inactive replication slots. It will also help to know the lifetime of a replication slot - one can know how long a streaming standby, logical subscriber, or replication slot consumer is down. The new column will be useful to implement inactive timeout based replication slot invalidation in a future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/system-views.sgml | 11 ++ src/backend/catalog/system_views.sql | 1 + src/backend/replication/slot.c | 27 +++++ src/backend/replication/slotfuncs.c | 7 +- src/include/catalog/pg_proc.dat | 6 +- src/include/replication/slot.h | 3 + src/test/recovery/meson.build | 1 + src/test/recovery/t/043_replslot_misc.pl | 127 +++++++++++++++++++++++ src/test/regress/expected/rules.out | 3 +- 9 files changed, 181 insertions(+), 5 deletions(-) create mode 100644 src/test/recovery/t/043_replslot_misc.pl diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index b5da476c20..2b36b5fef1 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2523,6 +2523,17 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>last_inactive_time</structfield> <type>timestamptz</type> + </para> + <para> + The time at which the slot became inactive. + <literal>NULL</literal> if the slot is currently actively being + used. + </para></entry> + </row> + <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>conflicting</structfield> <type>bool</type> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index f69b7f5580..bc70ff193e 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,6 +1023,7 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, + L.last_inactive_time, L.conflicting, L.invalidation_reason, L.failover, diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index cdf0c450c5..0f48d6dc7c 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,6 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; + slot->last_inactive_time = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -622,6 +623,11 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); + /* The slot is active by now, so reset the last inactive time. */ + SpinLockAcquire(&s->mutex); + s->last_inactive_time = 0; + SpinLockRelease(&s->mutex); + if (am_walsender) { ereport(log_replication_commands ? LOG : DEBUG1, @@ -645,6 +651,7 @@ ReplicationSlotRelease(void) ReplicationSlot *slot = MyReplicationSlot; char *slotname = NULL; /* keep compiler quiet */ bool is_logical = false; /* keep compiler quiet */ + TimestampTz now; Assert(slot != NULL && slot->active_pid != 0); @@ -679,6 +686,12 @@ ReplicationSlotRelease(void) ReplicationSlotsComputeRequiredXmin(false); } + /* + * Set the last inactive time after marking slot inactive. We get current + * time beforehand to avoid system call while holding the lock. + */ + now = GetCurrentTimestamp(); + if (slot->data.persistency == RS_PERSISTENT) { /* @@ -687,9 +700,16 @@ ReplicationSlotRelease(void) */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; + slot->last_inactive_time = now; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } + else + { + SpinLockAcquire(&slot->mutex); + slot->last_inactive_time = now; + SpinLockRelease(&slot->mutex); + } MyReplicationSlot = NULL; @@ -2342,6 +2362,13 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; + /* + * We set last inactive time after loading the slot from the disk into + * memory. Whoever acquires the slot i.e. makes the slot active will + * anyway reset it. + */ + slot->last_inactive_time = GetCurrentTimestamp(); + restored = true; break; } diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 4232c1e52e..24f5e6d90a 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 18 +#define PG_GET_REPLICATION_SLOTS_COLS 19 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -410,6 +410,11 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); + if (slot_contents.last_inactive_time > 0) + values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_time); + else + nulls[i++] = true; + cause = slot_contents.data.invalidated; if (SlotIsPhysical(&slot_contents)) diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 71c74350a0..0d26e5b422 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 7f25a083ee..2f18433ecc 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -201,6 +201,9 @@ typedef struct ReplicationSlot * forcibly flushed or not. */ XLogRecPtr last_saved_confirmed_flush; + + /* The time at which this slot become inactive */ + TimestampTz last_inactive_time; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/recovery/meson.build b/src/test/recovery/meson.build index b1eb77b1ec..c8259f99d5 100644 --- a/src/test/recovery/meson.build +++ b/src/test/recovery/meson.build @@ -51,6 +51,7 @@ tests += { 't/040_standby_failover_slots_sync.pl', 't/041_checkpoint_at_promote.pl', 't/042_low_level_backup.pl', + 't/043_replslot_misc.pl', ], }, } diff --git a/src/test/recovery/t/043_replslot_misc.pl b/src/test/recovery/t/043_replslot_misc.pl new file mode 100644 index 0000000000..86e58691bf --- /dev/null +++ b/src/test/recovery/t/043_replslot_misc.pl @@ -0,0 +1,127 @@ +# Copyright (c) 2024, PostgreSQL Global Development Group + +# Replication slot related miscellaneous tests +use strict; +use warnings FATAL => 'all'; +use PostgreSQL::Test::Cluster; +use PostgreSQL::Test::Utils; +use Test::More; + +# ============================================================================= +# Testcase start: Check last_inactive_time property of streaming standby's slot +# + +# Initialize primary node +my $primary = PostgreSQL::Test::Cluster->new('primary'); +$primary->init(allows_streaming => 'logical'); +$primary->start; + +# Take backup +my $backup_name = 'my_backup'; +$primary->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby = PostgreSQL::Test::Cluster->new('standby'); +$standby->init_from_backup($primary, $backup_name, has_streaming => 1); + +my $sb_slot = 'sb_slot'; +$standby->append_conf('postgresql.conf', "primary_slot_name = '$sb_slot'"); + +$primary->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := '$sb_slot'); +]); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the standby below. +my $last_inactive_time = $primary->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;) +); + +$standby->start; + +# Wait until standby has replayed enough data +$primary->wait_for_catchup($standby); + +# Now the slot is active so last_inactive_time value must be NULL +is( $primary->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$sb_slot';] + ), + 't', + 'last inactive time for an active physical slot is NULL'); + +# Stop the standby to check its last_inactive_time value is updated +$standby->stop; + +# Let's also restart the primary so that the last_inactive_time is set upon +# loading the slot from disk. +$primary->restart; + +is( $primary->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive physical slot is updated correctly'); + +# Testcase end: Check last_inactive_time property of streaming standby's slot +# ============================================================================= + +# ============================================================================= +# Testcase start: Check last_inactive_time property of logical subscriber's slot +my $publisher = $primary; + +# Create subscriber node +my $subscriber = PostgreSQL::Test::Cluster->new('sub'); +$subscriber->init; + +# Setup logical replication +my $publisher_connstr = $publisher->connstr . ' dbname=postgres'; +$publisher->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); + +my $lsub_slot = 'lsub_slot'; +$publisher->safe_psql('postgres', + "SELECT pg_create_logical_replication_slot(slot_name := '$lsub_slot', plugin := 'pgoutput');" +); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the subscriber below. +$last_inactive_time = $primary->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$lsub_slot' AND last_inactive_time IS NOT NULL;) +); + +$subscriber->start; +$subscriber->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher_connstr' PUBLICATION pub WITH (slot_name = '$lsub_slot', create_slot = false)" +); + +# Wait until subscriber has caught up +$subscriber->wait_for_subscription_sync($publisher, 'sub'); + +# Now the slot is active so last_inactive_time value must be NULL +is( $publisher->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub_slot';] + ), + 't', + 'last inactive time for an active logical slot is NULL'); + +# Stop the subscriber to check its last_inactive_time value is updated +$subscriber->stop; + +# Let's also restart the publisher so that the last_inactive_time is set upon +# loading the slot from disk. +$publisher->restart; + +is( $publisher->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive logical slot is updated correctly'); + +# Testcase end: Check last_inactive_time property of logical subscriber's slot +# ============================================================================= + +done_testing(); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 18829ea586..dfcbaec387 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,11 +1473,12 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, + l.last_inactive_time, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-23 09:04 Bertrand Drouvot <[email protected]> parent: Bharath Rupireddy <[email protected]> 1 sibling, 1 reply; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-23 09:04 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Sat, Mar 23, 2024 at 01:11:50PM +0530, Bharath Rupireddy wrote: > On Sat, Mar 23, 2024 at 11:27 AM Amit Kapila <[email protected]> wrote: > > > > How about adding the test in 019_replslot_limit? It is not a direct > > fit but I feel later we can even add 'invalid_timeout' related tests > > in this file which will use last_inactive_time feature. > > I'm thinking the other way. Now, the new TAP file 043_replslot_misc.pl > can have last_inactive_time tests, and later invalid_timeout ones too. > This way 019_replslot_limit.pl is not cluttered. I share the same opinion as Amit: I think 019_replslot_limit would be a better place, because I see the timeout as another kind of limit. > > > It is also > > possible that some of the tests added by the 'invalid_timeout' feature > > will obviate the need for some of these tests. > > Might be. But, I prefer to keep both these tests separate but in the > same file 043_replslot_misc.pl. Because we cover some corner cases the > last_inactive_time is set upon loading the slot from disk. Right but I think that this test does not necessary have to be in the same .pl as the one testing the timeout. Could be added in one of the existing .pl like 001_stream_rep.pl for example. Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-24 02:30 Bharath Rupireddy <[email protected]> parent: Bertrand Drouvot <[email protected]> 0 siblings, 0 replies; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-24 02:30 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Sat, Mar 23, 2024 at 2:34 PM Bertrand Drouvot <[email protected]> wrote: > > > > How about adding the test in 019_replslot_limit? It is not a direct > > > fit but I feel later we can even add 'invalid_timeout' related tests > > > in this file which will use last_inactive_time feature. > > > > I'm thinking the other way. Now, the new TAP file 043_replslot_misc.pl > > can have last_inactive_time tests, and later invalid_timeout ones too. > > This way 019_replslot_limit.pl is not cluttered. > > I share the same opinion as Amit: I think 019_replslot_limit would be a better > place, because I see the timeout as another kind of limit. Hm. Done that way. Please see the attached v17 patch. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/x-patch] v17-0001-Track-last_inactive_time-in-pg_replication_slots.patch (13.6K, ../../CALj2ACWW16qG+q8VsO7SVXNDnRxGxW=zOKe55zwQxbPH4+vZKg@mail.gmail.com/2-v17-0001-Track-last_inactive_time-in-pg_replication_slots.patch) download | inline diff: From a1210ae2dd86afdfdfea9b95861ffed9c7ff2d3a Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Sat, 23 Mar 2024 23:03:55 +0000 Subject: [PATCH v17] Track last_inactive_time in pg_replication_slots. Till now, the time at which the replication slot became inactive is not tracked directly in pg_replication_slots. This commit adds a new column 'last_inactive_time' for this. It is set to 0 whenever a slot is made active/acquired and set to current timestamp whenever the slot is inactive/released or restored from the disk. The new column will be useful on production servers to debug and analyze inactive replication slots. It will also help to know the lifetime of a replication slot - one can know how long a streaming standby, logical subscriber, or replication slot consumer is down. The new column will be useful to implement inactive timeout based replication slot invalidation in a future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/system-views.sgml | 11 ++ src/backend/catalog/system_views.sql | 1 + src/backend/replication/slot.c | 27 +++++ src/backend/replication/slotfuncs.c | 7 +- src/include/catalog/pg_proc.dat | 6 +- src/include/replication/slot.h | 3 + src/test/recovery/t/019_replslot_limit.pl | 122 ++++++++++++++++++++++ src/test/regress/expected/rules.out | 3 +- 8 files changed, 175 insertions(+), 5 deletions(-) diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index b5da476c20..2b36b5fef1 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2523,6 +2523,17 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>last_inactive_time</structfield> <type>timestamptz</type> + </para> + <para> + The time at which the slot became inactive. + <literal>NULL</literal> if the slot is currently actively being + used. + </para></entry> + </row> + <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>conflicting</structfield> <type>bool</type> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index f69b7f5580..bc70ff193e 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,6 +1023,7 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, + L.last_inactive_time, L.conflicting, L.invalidation_reason, L.failover, diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index cdf0c450c5..0f48d6dc7c 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,6 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; + slot->last_inactive_time = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -622,6 +623,11 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); + /* The slot is active by now, so reset the last inactive time */ + SpinLockAcquire(&s->mutex); + s->last_inactive_time = 0; + SpinLockRelease(&s->mutex); + if (am_walsender) { ereport(log_replication_commands ? LOG : DEBUG1, @@ -645,6 +651,7 @@ ReplicationSlotRelease(void) ReplicationSlot *slot = MyReplicationSlot; char *slotname = NULL; /* keep compiler quiet */ bool is_logical = false; /* keep compiler quiet */ + TimestampTz now; Assert(slot != NULL && slot->active_pid != 0); @@ -679,6 +686,12 @@ ReplicationSlotRelease(void) ReplicationSlotsComputeRequiredXmin(false); } + /* + * Set the last inactive time after marking slot inactive. We get current + * time beforehand to avoid system call while holding the lock. + */ + now = GetCurrentTimestamp(); + if (slot->data.persistency == RS_PERSISTENT) { /* @@ -687,9 +700,16 @@ ReplicationSlotRelease(void) */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; + slot->last_inactive_time = now; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } + else + { + SpinLockAcquire(&slot->mutex); + slot->last_inactive_time = now; + SpinLockRelease(&slot->mutex); + } MyReplicationSlot = NULL; @@ -2342,6 +2362,13 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; + /* + * We set last inactive time after loading the slot from the disk into + * memory. Whoever acquires the slot i.e. makes the slot active will + * anyway reset it. + */ + slot->last_inactive_time = GetCurrentTimestamp(); + restored = true; break; } diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 4232c1e52e..24f5e6d90a 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 18 +#define PG_GET_REPLICATION_SLOTS_COLS 19 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -410,6 +410,11 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); + if (slot_contents.last_inactive_time > 0) + values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_time); + else + nulls[i++] = true; + cause = slot_contents.data.invalidated; if (SlotIsPhysical(&slot_contents)) diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 71c74350a0..0d26e5b422 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 7f25a083ee..2f18433ecc 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -201,6 +201,9 @@ typedef struct ReplicationSlot * forcibly flushed or not. */ XLogRecPtr last_saved_confirmed_flush; + + /* The time at which this slot become inactive */ + TimestampTz last_inactive_time; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl index fe00370c3e..a14b6283ee 100644 --- a/src/test/recovery/t/019_replslot_limit.pl +++ b/src/test/recovery/t/019_replslot_limit.pl @@ -410,4 +410,126 @@ kill 'CONT', $receiverpid; $node_primary3->stop; $node_standby3->stop; +# ============================================================================= +# Testcase start: Check last_inactive_time property of streaming standby's slot +# + +# Initialize primary node +my $primary4 = PostgreSQL::Test::Cluster->new('primary4'); +$primary4->init(allows_streaming => 'logical'); +$primary4->start; + +# Take backup +$backup_name = 'my_backup4'; +$primary4->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby4 = PostgreSQL::Test::Cluster->new('standby4'); +$standby4->init_from_backup($primary4, $backup_name, has_streaming => 1); + +my $sb4_slot = 'sb4_slot'; +$standby4->append_conf('postgresql.conf', "primary_slot_name = '$sb4_slot'"); + +$primary4->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := '$sb4_slot'); +]); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the standby below. +my $last_inactive_time = $primary4->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;) +); + +$standby4->start; + +# Wait until standby has replayed enough data +$primary4->wait_for_catchup($standby4); + +# Now the slot is active so last_inactive_time value must be NULL +is( $primary4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$sb4_slot';] + ), + 't', + 'last inactive time for an active physical slot is NULL'); + +# Stop the standby to check its last_inactive_time value is updated +$standby4->stop; + +# Let's also restart the primary so that the last_inactive_time is set upon +# loading the slot from disk. +$primary4->restart; + +is( $primary4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive physical slot is updated correctly'); + +$standby4->stop; + +# Testcase end: Check last_inactive_time property of streaming standby's slot +# ============================================================================= + +# ============================================================================= +# Testcase start: Check last_inactive_time property of logical subscriber's slot +my $publisher4 = $primary4; + +# Create subscriber node +my $subscriber4 = PostgreSQL::Test::Cluster->new('subscriber4'); +$subscriber4->init; + +# Setup logical replication +my $publisher4_connstr = $publisher4->connstr . ' dbname=postgres'; +$publisher4->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); + +my $lsub4_slot = 'lsub4_slot'; +$publisher4->safe_psql('postgres', + "SELECT pg_create_logical_replication_slot(slot_name := '$lsub4_slot', plugin := 'pgoutput');" +); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the subscriber below. +$last_inactive_time = $publisher4->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;) +); + +$subscriber4->start; +$subscriber4->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher4_connstr' PUBLICATION pub WITH (slot_name = '$lsub4_slot', create_slot = false)" +); + +# Wait until subscriber has caught up +$subscriber4->wait_for_subscription_sync($publisher4, 'sub'); + +# Now the slot is active so last_inactive_time value must be NULL +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub4_slot';] + ), + 't', + 'last inactive time for an active logical slot is NULL'); + +# Stop the subscriber to check its last_inactive_time value is updated +$subscriber4->stop; + +# Let's also restart the publisher so that the last_inactive_time is set upon +# loading the slot from disk. +$publisher4->restart; + +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive logical slot is updated correctly'); + +# Testcase end: Check last_inactive_time property of logical subscriber's slot +# ============================================================================= + +$publisher4->stop; +$subscriber4->stop; + done_testing(); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 18829ea586..dfcbaec387 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,11 +1473,12 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, + l.last_inactive_time, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-24 05:10 Amit Kapila <[email protected]> parent: Bharath Rupireddy <[email protected]> 1 sibling, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-24 05:10 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Sat, Mar 23, 2024 at 1:12 PM Bharath Rupireddy <[email protected]> wrote: > > On Sat, Mar 23, 2024 at 11:27 AM Amit Kapila <[email protected]> wrote: > > > > > 2. > > +# Get last_inactive_time value after slot's creation. Note that the > > slot is still > > +# inactive unless it's used by the standby below. > > +my $last_inactive_time_1 = $primary->safe_psql('postgres', > > + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE > > slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;) > > +); > > > > We should check $last_inactive_time_1 to be a valid value and add a > > similar check for logical slots. > > That's taken care by the type cast we do, right? Isn't that enough? > > is( $primary->safe_psql( > 'postgres', > qq[SELECT last_inactive_time > > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE > slot_name = '$sb_slot' AND last_inactive_time IS NOT NULL;] > ), > 't', > 'last inactive time for an inactive physical slot is updated correctly'); > > For instance, setting last_inactive_time_1 to an invalid value fails > with the following error: > > error running SQL: 'psql:<stdin>:1: ERROR: invalid input syntax for > type timestamp with time zone: "foo" > LINE 1: SELECT last_inactive_time > 'foo'::timestamptz FROM pg_repli... > It would be found at a later point. It would be probably better to verify immediately after the test that fetches the last_inactive_time value. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-24 09:35 Bharath Rupireddy <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 4 replies; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-24 09:35 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Sun, Mar 24, 2024 at 10:40 AM Amit Kapila <[email protected]> wrote: > > > For instance, setting last_inactive_time_1 to an invalid value fails > > with the following error: > > > > error running SQL: 'psql:<stdin>:1: ERROR: invalid input syntax for > > type timestamp with time zone: "foo" > > LINE 1: SELECT last_inactive_time > 'foo'::timestamptz FROM pg_repli... > > > > It would be found at a later point. It would be probably better to > verify immediately after the test that fetches the last_inactive_time > value. Agree. I've added a few more checks explicitly to verify the last_inactive_time is sane with the following: qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) AND '$last_inactive_time'::timestamptz > '$slot_creation_time'::timestamptz;] I've attached the v18 patch set here. I've also addressed earlier review comments from Amit, Ajin Cherian. Note that I've added new invalidation mechanism tests in a separate TAP test file just because I don't want to clutter or bloat any of the existing files and spread tests for physical slots and logical slots into separate existing TAP files. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/octet-stream] v18-0001-Track-last_inactive_time-in-pg_replication_slots.patch (14.4K, ../../CALj2ACU6tV0bh_MiFBYU7-VK2cj8Gas73htcQjoOv0uvSEG_HA@mail.gmail.com/2-v18-0001-Track-last_inactive_time-in-pg_replication_slots.patch) download | inline diff: From 79c3967c0dc25ec2741f7fe979b2b97939e2eeb1 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Sun, 24 Mar 2024 07:12:55 +0000 Subject: [PATCH v18 1/5] Track last_inactive_time in pg_replication_slots. Till now, the time at which the replication slot became inactive is not tracked directly in pg_replication_slots. This commit adds a new property called last_inactive_time for this. It is set to 0 whenever a slot is made active/acquired and set to current timestamp whenever the slot is inactive/released or restored from the disk. The new property will be useful on production servers to debug and analyze inactive replication slots. It will also help to know the lifetime of a replication slot - one can know how long a streaming standby, logical subscriber, or replication slot consumer is down. The new property will be useful to implement inactive timeout based replication slot invalidation in a future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/system-views.sgml | 11 ++ src/backend/catalog/system_views.sql | 1 + src/backend/replication/slot.c | 27 ++++ src/backend/replication/slotfuncs.c | 7 +- src/include/catalog/pg_proc.dat | 6 +- src/include/replication/slot.h | 3 + src/test/recovery/t/019_replslot_limit.pl | 148 ++++++++++++++++++++++ src/test/regress/expected/rules.out | 3 +- 8 files changed, 201 insertions(+), 5 deletions(-) diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index b5da476c20..2b36b5fef1 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2523,6 +2523,17 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>last_inactive_time</structfield> <type>timestamptz</type> + </para> + <para> + The time at which the slot became inactive. + <literal>NULL</literal> if the slot is currently actively being + used. + </para></entry> + </row> + <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>conflicting</structfield> <type>bool</type> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index f69b7f5580..bc70ff193e 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,6 +1023,7 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, + L.last_inactive_time, L.conflicting, L.invalidation_reason, L.failover, diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index cdf0c450c5..0f48d6dc7c 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,6 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; + slot->last_inactive_time = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -622,6 +623,11 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); + /* The slot is active by now, so reset the last inactive time. */ + SpinLockAcquire(&s->mutex); + s->last_inactive_time = 0; + SpinLockRelease(&s->mutex); + if (am_walsender) { ereport(log_replication_commands ? LOG : DEBUG1, @@ -645,6 +651,7 @@ ReplicationSlotRelease(void) ReplicationSlot *slot = MyReplicationSlot; char *slotname = NULL; /* keep compiler quiet */ bool is_logical = false; /* keep compiler quiet */ + TimestampTz now; Assert(slot != NULL && slot->active_pid != 0); @@ -679,6 +686,12 @@ ReplicationSlotRelease(void) ReplicationSlotsComputeRequiredXmin(false); } + /* + * Set the last inactive time after marking slot inactive. We get current + * time beforehand to avoid system call while holding the lock. + */ + now = GetCurrentTimestamp(); + if (slot->data.persistency == RS_PERSISTENT) { /* @@ -687,9 +700,16 @@ ReplicationSlotRelease(void) */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; + slot->last_inactive_time = now; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } + else + { + SpinLockAcquire(&slot->mutex); + slot->last_inactive_time = now; + SpinLockRelease(&slot->mutex); + } MyReplicationSlot = NULL; @@ -2342,6 +2362,13 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; + /* + * We set last inactive time after loading the slot from the disk into + * memory. Whoever acquires the slot i.e. makes the slot active will + * anyway reset it. + */ + slot->last_inactive_time = GetCurrentTimestamp(); + restored = true; break; } diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 4232c1e52e..24f5e6d90a 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 18 +#define PG_GET_REPLICATION_SLOTS_COLS 19 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -410,6 +410,11 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); + if (slot_contents.last_inactive_time > 0) + values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_time); + else + nulls[i++] = true; + cause = slot_contents.data.invalidated; if (SlotIsPhysical(&slot_contents)) diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 71c74350a0..0d26e5b422 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 7f25a083ee..2f18433ecc 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -201,6 +201,9 @@ typedef struct ReplicationSlot * forcibly flushed or not. */ XLogRecPtr last_saved_confirmed_flush; + + /* The time at which this slot become inactive */ + TimestampTz last_inactive_time; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl index fe00370c3e..bff84cc9c4 100644 --- a/src/test/recovery/t/019_replslot_limit.pl +++ b/src/test/recovery/t/019_replslot_limit.pl @@ -410,4 +410,152 @@ kill 'CONT', $receiverpid; $node_primary3->stop; $node_standby3->stop; +# ============================================================================= +# Testcase start: Check last_inactive_time property of streaming standby's slot +# + +# Initialize primary node +my $primary4 = PostgreSQL::Test::Cluster->new('primary4'); +$primary4->init(allows_streaming => 'logical'); +$primary4->start; + +# Take backup +$backup_name = 'my_backup4'; +$primary4->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby4 = PostgreSQL::Test::Cluster->new('standby4'); +$standby4->init_from_backup($primary4, $backup_name, has_streaming => 1); + +my $sb4_slot = 'sb4_slot'; +$standby4->append_conf('postgresql.conf', "primary_slot_name = '$sb4_slot'"); + +my $slot_creation_time = $primary4->safe_psql( + 'postgres', qq[ + SELECT current_timestamp; +]); + +$primary4->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := '$sb4_slot'); +]); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the standby below. +my $last_inactive_time = $primary4->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;) +); + +# Check that the captured time is sane +is( $primary4->safe_psql( + 'postgres', + qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) AND '$last_inactive_time'::timestamptz > '$slot_creation_time'::timestamptz;] + ), + 't', + 'last inactive time for an active physical slot is sane'); + +$standby4->start; + +# Wait until standby has replayed enough data +$primary4->wait_for_catchup($standby4); + +# Now the slot is active so last_inactive_time value must be NULL +is( $primary4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$sb4_slot';] + ), + 't', + 'last inactive time for an active physical slot is NULL'); + +# Stop the standby to check its last_inactive_time value is updated +$standby4->stop; + +# Let's also restart the primary so that the last_inactive_time is set upon +# loading the slot from disk. +$primary4->restart; + +is( $primary4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive physical slot is updated correctly'); + +$standby4->stop; + +# Testcase end: Check last_inactive_time property of streaming standby's slot +# ============================================================================= + +# ============================================================================= +# Testcase start: Check last_inactive_time property of logical subscriber's slot +my $publisher4 = $primary4; + +# Create subscriber node +my $subscriber4 = PostgreSQL::Test::Cluster->new('subscriber4'); +$subscriber4->init; + +# Setup logical replication +my $publisher4_connstr = $publisher4->connstr . ' dbname=postgres'; +$publisher4->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); + +$slot_creation_time = $publisher4->safe_psql( + 'postgres', qq[ + SELECT current_timestamp; +]); + +my $lsub4_slot = 'lsub4_slot'; +$publisher4->safe_psql('postgres', + "SELECT pg_create_logical_replication_slot(slot_name := '$lsub4_slot', plugin := 'pgoutput');" +); + +# Get last_inactive_time value after slot's creation. Note that the slot is still +# inactive unless it's used by the subscriber below. +$last_inactive_time = $publisher4->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;) +); + +# Check that the captured time is sane +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) AND '$last_inactive_time'::timestamptz > '$slot_creation_time'::timestamptz;] + ), + 't', + 'last inactive time for an active physical slot is sane'); + +$subscriber4->start; +$subscriber4->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher4_connstr' PUBLICATION pub WITH (slot_name = '$lsub4_slot', create_slot = false)" +); + +# Wait until subscriber has caught up +$subscriber4->wait_for_subscription_sync($publisher4, 'sub'); + +# Now the slot is active so last_inactive_time value must be NULL +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub4_slot';] + ), + 't', + 'last inactive time for an active logical slot is NULL'); + +# Stop the subscriber to check its last_inactive_time value is updated +$subscriber4->stop; + +# Let's also restart the publisher so that the last_inactive_time is set upon +# loading the slot from disk. +$publisher4->restart; + +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive logical slot is updated correctly'); + +# Testcase end: Check last_inactive_time property of logical subscriber's slot +# ============================================================================= + +$publisher4->stop; +$subscriber4->stop; + done_testing(); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 18829ea586..dfcbaec387 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,11 +1473,12 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, + l.last_inactive_time, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 [application/octet-stream] v18-0002-Allow-setting-inactive_timeout-for-replication-s.patch (36.3K, ../../CALj2ACU6tV0bh_MiFBYU7-VK2cj8Gas73htcQjoOv0uvSEG_HA@mail.gmail.com/3-v18-0002-Allow-setting-inactive_timeout-for-replication-s.patch) download | inline diff: From 0d80cfad9658c7303d036833636b22293fd25109 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Sun, 24 Mar 2024 07:14:51 +0000 Subject: [PATCH v18 2/5] Allow setting inactive_timeout for replication slots via SQL API. This commit adds a new replication slot property called inactive_timeout specifying the amount of time in seconds the slot is allowed to be inactive. It is added to slot's persistent data structure to survive during server restarts. It will be synced to failover slots on the standby, and also will be carried over to the new cluster as part of pg_upgrade. This commit particularly lets one specify the inactive_timeout for a slot via SQL functions pg_create_physical_replication_slot and pg_create_logical_replication_slot. The new property will be useful to implement inactive timeout based replication slot invalidation in a future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- contrib/test_decoding/expected/slot.out | 102 ++++++++++++++++++ contrib/test_decoding/sql/slot.sql | 34 ++++++ doc/src/sgml/func.sgml | 18 ++-- doc/src/sgml/system-views.sgml | 9 ++ src/backend/catalog/system_functions.sql | 2 + src/backend/catalog/system_views.sql | 1 + src/backend/replication/logical/slotsync.c | 17 ++- src/backend/replication/slot.c | 20 +++- src/backend/replication/slotfuncs.c | 31 +++++- src/backend/replication/walsender.c | 4 +- src/bin/pg_upgrade/info.c | 6 +- src/bin/pg_upgrade/pg_upgrade.c | 5 +- src/bin/pg_upgrade/pg_upgrade.h | 2 + src/bin/pg_upgrade/t/003_logical_slots.pl | 11 +- src/include/catalog/pg_proc.dat | 22 ++-- src/include/replication/slot.h | 5 +- .../t/040_standby_failover_slots_sync.pl | 13 ++- src/test/regress/expected/rules.out | 3 +- 18 files changed, 264 insertions(+), 41 deletions(-) diff --git a/contrib/test_decoding/expected/slot.out b/contrib/test_decoding/expected/slot.out index 349ab2d380..6771520afb 100644 --- a/contrib/test_decoding/expected/slot.out +++ b/contrib/test_decoding/expected/slot.out @@ -466,3 +466,105 @@ SELECT pg_drop_replication_slot('physical_slot'); (1 row) +-- Test negative value for inactive_timeout option for slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', inactive_timeout := -300); -- error +ERROR: "inactive_timeout" must not be negative +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', inactive_timeout := -600); -- error +ERROR: "inactive_timeout" must not be negative +-- Test inactive_timeout option for temporary slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', temporary := true, inactive_timeout := 300); -- error +ERROR: cannot set inactive_timeout for a temporary replication slot +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', temporary := true, inactive_timeout := 600); -- error +ERROR: cannot set inactive_timeout for a temporary replication slot +-- Test inactive_timeout option of physical slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot1', immediately_reserve := true, inactive_timeout := 300); + ?column? +---------- + init +(1 row) + +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot2'); + ?column? +---------- + init +(1 row) + +-- Copy physical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); + ?column? +---------- + copy +(1 row) + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + slot_name | slot_type | inactive_timeout +--------------+-----------+------------------ + it_phy_slot1 | physical | 300 + it_phy_slot2 | physical | 0 + it_phy_slot3 | physical | 300 +(3 rows) + +SELECT pg_drop_replication_slot('it_phy_slot1'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_phy_slot2'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_phy_slot3'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +-- Test inactive_timeout option of logical slots. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); + ?column? +---------- + init +(1 row) + +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2', plugin := 'test_decoding'); + ?column? +---------- + init +(1 row) + +-- Copy logical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); + ?column? +---------- + copy +(1 row) + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + slot_name | slot_type | inactive_timeout +--------------+-----------+------------------ + it_log_slot1 | logical | 600 + it_log_slot2 | logical | 0 + it_log_slot3 | logical | 600 +(3 rows) + +SELECT pg_drop_replication_slot('it_log_slot1'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_log_slot2'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_log_slot3'); + pg_drop_replication_slot +-------------------------- + +(1 row) + diff --git a/contrib/test_decoding/sql/slot.sql b/contrib/test_decoding/sql/slot.sql index 580e3ae3be..443e91da07 100644 --- a/contrib/test_decoding/sql/slot.sql +++ b/contrib/test_decoding/sql/slot.sql @@ -190,3 +190,37 @@ SELECT pg_drop_replication_slot('failover_true_slot'); SELECT pg_drop_replication_slot('failover_false_slot'); SELECT pg_drop_replication_slot('failover_default_slot'); SELECT pg_drop_replication_slot('physical_slot'); + +-- Test negative value for inactive_timeout option for slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', inactive_timeout := -300); -- error +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', inactive_timeout := -600); -- error + +-- Test inactive_timeout option for temporary slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', temporary := true, inactive_timeout := 300); -- error +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', temporary := true, inactive_timeout := 600); -- error + +-- Test inactive_timeout option of physical slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot1', immediately_reserve := true, inactive_timeout := 300); +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot2'); + +-- Copy physical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + +SELECT pg_drop_replication_slot('it_phy_slot1'); +SELECT pg_drop_replication_slot('it_phy_slot2'); +SELECT pg_drop_replication_slot('it_phy_slot3'); + +-- Test inactive_timeout option of logical slots. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2', plugin := 'test_decoding'); + +-- Copy logical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + +SELECT pg_drop_replication_slot('it_log_slot1'); +SELECT pg_drop_replication_slot('it_log_slot2'); +SELECT pg_drop_replication_slot('it_log_slot3'); diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 8ecc02f2b9..afaafa35ad 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28373,7 +28373,7 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <indexterm> <primary>pg_create_physical_replication_slot</primary> </indexterm> - <function>pg_create_physical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type> <optional>, <parameter>immediately_reserve</parameter> <type>boolean</type>, <parameter>temporary</parameter> <type>boolean</type> </optional> ) + <function>pg_create_physical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type> <optional>, <parameter>immediately_reserve</parameter> <type>boolean</type>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>inactive_timeout</parameter> <type>integer</type> </optional>) <returnvalue>record</returnvalue> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>lsn</parameter> <type>pg_lsn</type> ) @@ -28390,9 +28390,12 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset parameter, <parameter>temporary</parameter>, when set to true, specifies that the slot should not be permanently stored to disk and is only meant for use by the current session. Temporary slots are also - released upon any error. This function corresponds - to the replication protocol command <literal>CREATE_REPLICATION_SLOT - ... PHYSICAL</literal>. + released upon any error. The optional fourth + parameter, <parameter>inactive_timeout</parameter>, when set to a + non-zero value, specifies the amount of time in seconds the slot is + allowed to be inactive. This function corresponds to the replication + protocol command + <literal>CREATE_REPLICATION_SLOT ... PHYSICAL</literal>. </para></entry> </row> @@ -28417,7 +28420,7 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <indexterm> <primary>pg_create_logical_replication_slot</primary> </indexterm> - <function>pg_create_logical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>plugin</parameter> <type>name</type> <optional>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>twophase</parameter> <type>boolean</type>, <parameter>failover</parameter> <type>boolean</type> </optional> ) + <function>pg_create_logical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>plugin</parameter> <type>name</type> <optional>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>twophase</parameter> <type>boolean</type>, <parameter>failover</parameter> <type>boolean</type>, <parameter>inactive_timeout</parameter> <type>integer</type> </optional> ) <returnvalue>record</returnvalue> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>lsn</parameter> <type>pg_lsn</type> ) @@ -28436,7 +28439,10 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <parameter>failover</parameter>, when set to true, specifies that this slot is enabled to be synced to the standbys so that logical replication can be resumed after - failover. A call to this function has the same effect as + failover. The optional sixth parameter, + <parameter>inactive_timeout</parameter>, when set to a + non-zero value, specifies the amount of time in seconds the slot is + allowed to be inactive. A call to this function has the same effect as the replication protocol command <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. </para></entry> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 2b36b5fef1..dddbaa070f 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2534,6 +2534,15 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>inactive_timeout</structfield> <type>integer</type> + </para> + <para> + The amount of time in seconds the slot is allowed to be inactive. + </para></entry> + </row> + <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>conflicting</structfield> <type>bool</type> diff --git a/src/backend/catalog/system_functions.sql b/src/backend/catalog/system_functions.sql index fe2bb50f46..af27616657 100644 --- a/src/backend/catalog/system_functions.sql +++ b/src/backend/catalog/system_functions.sql @@ -469,6 +469,7 @@ AS 'pg_logical_emit_message_bytea'; CREATE OR REPLACE FUNCTION pg_create_physical_replication_slot( IN slot_name name, IN immediately_reserve boolean DEFAULT false, IN temporary boolean DEFAULT false, + IN inactive_timeout int DEFAULT 0, OUT slot_name name, OUT lsn pg_lsn) RETURNS RECORD LANGUAGE INTERNAL @@ -480,6 +481,7 @@ CREATE OR REPLACE FUNCTION pg_create_logical_replication_slot( IN temporary boolean DEFAULT false, IN twophase boolean DEFAULT false, IN failover boolean DEFAULT false, + IN inactive_timeout int DEFAULT 0, OUT slot_name name, OUT lsn pg_lsn) RETURNS RECORD LANGUAGE INTERNAL diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index bc70ff193e..40d7ad469d 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1024,6 +1024,7 @@ CREATE VIEW pg_replication_slots AS L.safe_wal_size, L.two_phase, L.last_inactive_time, + L.inactive_timeout, L.conflicting, L.invalidation_reason, L.failover, diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index 30480960c5..c01876ceeb 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -131,6 +131,7 @@ typedef struct RemoteSlot char *database; bool two_phase; bool failover; + int inactive_timeout; XLogRecPtr restart_lsn; XLogRecPtr confirmed_lsn; TransactionId catalog_xmin; @@ -167,7 +168,8 @@ update_local_synced_slot(RemoteSlot *remote_slot, Oid remote_dbid) remote_slot->two_phase == slot->data.two_phase && remote_slot->failover == slot->data.failover && remote_slot->confirmed_lsn == slot->data.confirmed_flush && - strcmp(remote_slot->plugin, NameStr(slot->data.plugin)) == 0) + strcmp(remote_slot->plugin, NameStr(slot->data.plugin)) == 0 && + remote_slot->inactive_timeout == slot->data.inactive_timeout) return false; /* Avoid expensive operations while holding a spinlock. */ @@ -182,6 +184,7 @@ update_local_synced_slot(RemoteSlot *remote_slot, Oid remote_dbid) slot->data.confirmed_flush = remote_slot->confirmed_lsn; slot->data.catalog_xmin = remote_slot->catalog_xmin; slot->effective_catalog_xmin = remote_slot->catalog_xmin; + slot->data.inactive_timeout = remote_slot->inactive_timeout; SpinLockRelease(&slot->mutex); if (xmin_changed) @@ -607,7 +610,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) ReplicationSlotCreate(remote_slot->name, true, RS_TEMPORARY, remote_slot->two_phase, remote_slot->failover, - true); + true, 0); /* For shorter lines. */ slot = MyReplicationSlot; @@ -627,6 +630,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) SpinLockAcquire(&slot->mutex); slot->effective_catalog_xmin = xmin_horizon; slot->data.catalog_xmin = xmin_horizon; + slot->data.inactive_timeout = remote_slot->inactive_timeout; SpinLockRelease(&slot->mutex); ReplicationSlotsComputeRequiredXmin(true); LWLockRelease(ProcArrayLock); @@ -652,9 +656,9 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) static bool synchronize_slots(WalReceiverConn *wrconn) { -#define SLOTSYNC_COLUMN_COUNT 9 +#define SLOTSYNC_COLUMN_COUNT 10 Oid slotRow[SLOTSYNC_COLUMN_COUNT] = {TEXTOID, TEXTOID, LSNOID, - LSNOID, XIDOID, BOOLOID, BOOLOID, TEXTOID, TEXTOID}; + LSNOID, XIDOID, BOOLOID, BOOLOID, TEXTOID, TEXTOID, INT4OID}; WalRcvExecResult *res; TupleTableSlot *tupslot; @@ -663,7 +667,7 @@ synchronize_slots(WalReceiverConn *wrconn) bool started_tx = false; const char *query = "SELECT slot_name, plugin, confirmed_flush_lsn," " restart_lsn, catalog_xmin, two_phase, failover," - " database, invalidation_reason" + " database, invalidation_reason, inactive_timeout" " FROM pg_catalog.pg_replication_slots" " WHERE failover and NOT temporary"; @@ -743,6 +747,9 @@ synchronize_slots(WalReceiverConn *wrconn) remote_slot->invalidated = isnull ? RS_INVAL_NONE : GetSlotInvalidationCause(TextDatumGetCString(d)); + remote_slot->inactive_timeout = DatumGetInt32(slot_getattr(tupslot, ++col, + &isnull)); + /* Sanity check */ Assert(col == SLOTSYNC_COLUMN_COUNT); diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 0f48d6dc7c..852a657e97 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -129,7 +129,7 @@ StaticAssertDecl(lengthof(SlotInvalidationCauses) == (RS_INVAL_MAX_CAUSES + 1), sizeof(ReplicationSlotOnDisk) - ReplicationSlotOnDiskConstantSize #define SLOT_MAGIC 0x1051CA1 /* format identifier */ -#define SLOT_VERSION 5 /* version for new files */ +#define SLOT_VERSION 6 /* version for new files */ /* Control array for replication slot management */ ReplicationSlotCtlData *ReplicationSlotCtl = NULL; @@ -304,11 +304,14 @@ ReplicationSlotValidateName(const char *name, int elevel) * failover: If enabled, allows the slot to be synced to standbys so * that logical replication can be resumed after failover. * synced: True if the slot is synchronized from the primary server. + * inactive_timeout: The amount of time in seconds the slot is allowed to be + * inactive. */ void ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, - bool two_phase, bool failover, bool synced) + bool two_phase, bool failover, bool synced, + int inactive_timeout) { ReplicationSlot *slot = NULL; int i; @@ -345,6 +348,18 @@ ReplicationSlotCreate(const char *name, bool db_specific, errmsg("cannot enable failover for a temporary replication slot")); } + if (inactive_timeout > 0) + { + /* + * Do not allow users to set inactive_timeout for temporary slots, + * because temporary slots will not be saved to the disk. + */ + if (persistency == RS_TEMPORARY) + ereport(ERROR, + errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("cannot set inactive_timeout for a temporary replication slot")); + } + /* * If some other backend ran this code concurrently with us, we'd likely * both allocate the same slot, and that would be bad. We'd also be at @@ -398,6 +413,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->data.two_phase_at = InvalidXLogRecPtr; slot->data.failover = failover; slot->data.synced = synced; + slot->data.inactive_timeout = inactive_timeout; /* and then data only present in shared memory */ slot->just_dirtied = false; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 24f5e6d90a..fb79401c50 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -38,14 +38,15 @@ */ static void create_physical_replication_slot(char *name, bool immediately_reserve, - bool temporary, XLogRecPtr restart_lsn) + bool temporary, int inactive_timeout, + XLogRecPtr restart_lsn) { Assert(!MyReplicationSlot); /* acquire replication slot, this will check for conflicting names */ ReplicationSlotCreate(name, false, temporary ? RS_TEMPORARY : RS_PERSISTENT, false, - false, false); + false, false, inactive_timeout); if (immediately_reserve) { @@ -71,6 +72,7 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) Name name = PG_GETARG_NAME(0); bool immediately_reserve = PG_GETARG_BOOL(1); bool temporary = PG_GETARG_BOOL(2); + int inactive_timeout = PG_GETARG_INT32(3); Datum values[2]; bool nulls[2]; TupleDesc tupdesc; @@ -84,9 +86,15 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) CheckSlotRequirements(); + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + create_physical_replication_slot(NameStr(*name), immediately_reserve, temporary, + inactive_timeout, InvalidXLogRecPtr); values[0] = NameGetDatum(&MyReplicationSlot->data.name); @@ -120,7 +128,7 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) static void create_logical_replication_slot(char *name, char *plugin, bool temporary, bool two_phase, - bool failover, + bool failover, int inactive_timeout, XLogRecPtr restart_lsn, bool find_startpoint) { @@ -138,7 +146,7 @@ create_logical_replication_slot(char *name, char *plugin, */ ReplicationSlotCreate(name, true, temporary ? RS_TEMPORARY : RS_EPHEMERAL, two_phase, - failover, false); + failover, false, inactive_timeout); /* * Create logical decoding context to find start point or, if we don't @@ -177,6 +185,7 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) bool temporary = PG_GETARG_BOOL(2); bool two_phase = PG_GETARG_BOOL(3); bool failover = PG_GETARG_BOOL(4); + int inactive_timeout = PG_GETARG_INT32(5); Datum result; TupleDesc tupdesc; HeapTuple tuple; @@ -190,11 +199,17 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) CheckLogicalDecodingRequirements(); + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + create_logical_replication_slot(NameStr(*name), NameStr(*plugin), temporary, two_phase, failover, + inactive_timeout, InvalidXLogRecPtr, true); @@ -239,7 +254,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 19 +#define PG_GET_REPLICATION_SLOTS_COLS 20 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -415,6 +430,8 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) else nulls[i++] = true; + values[i++] = Int32GetDatum(slot_contents.data.inactive_timeout); + cause = slot_contents.data.invalidated; if (SlotIsPhysical(&slot_contents)) @@ -720,6 +737,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) XLogRecPtr src_restart_lsn; bool src_islogical; bool temporary; + int inactive_timeout; char *plugin; Datum values[2]; bool nulls[2]; @@ -776,6 +794,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) src_restart_lsn = first_slot_contents.data.restart_lsn; temporary = (first_slot_contents.data.persistency == RS_TEMPORARY); plugin = logical_slot ? NameStr(first_slot_contents.data.plugin) : NULL; + inactive_timeout = first_slot_contents.data.inactive_timeout; /* Check type of replication slot */ if (src_islogical != logical_slot) @@ -823,6 +842,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) temporary, false, false, + inactive_timeout, src_restart_lsn, false); } @@ -830,6 +850,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) create_physical_replication_slot(NameStr(*dst_name), true, temporary, + inactive_timeout, src_restart_lsn); /* diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index bc40c454de..5315c08650 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -1221,7 +1221,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) { ReplicationSlotCreate(cmd->slotname, false, cmd->temporary ? RS_TEMPORARY : RS_PERSISTENT, - false, false, false); + false, false, false, 0); if (reserve_wal) { @@ -1252,7 +1252,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) */ ReplicationSlotCreate(cmd->slotname, true, cmd->temporary ? RS_TEMPORARY : RS_EPHEMERAL, - two_phase, failover, false); + two_phase, failover, false, 0); /* * Do options check early so that we can bail before calling the diff --git a/src/bin/pg_upgrade/info.c b/src/bin/pg_upgrade/info.c index 95c22a7200..12626987f0 100644 --- a/src/bin/pg_upgrade/info.c +++ b/src/bin/pg_upgrade/info.c @@ -676,7 +676,8 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) * removed. */ res = executeQueryOrDie(conn, "SELECT slot_name, plugin, two_phase, failover, " - "%s as caught_up, invalidation_reason IS NOT NULL as invalid " + "%s as caught_up, invalidation_reason IS NOT NULL as invalid, " + "inactive_timeout " "FROM pg_catalog.pg_replication_slots " "WHERE slot_type = 'logical' AND " "database = current_database() AND " @@ -696,6 +697,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) int i_failover; int i_caught_up; int i_invalid; + int i_inactive_timeout; slotinfos = (LogicalSlotInfo *) pg_malloc(sizeof(LogicalSlotInfo) * num_slots); @@ -705,6 +707,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) i_failover = PQfnumber(res, "failover"); i_caught_up = PQfnumber(res, "caught_up"); i_invalid = PQfnumber(res, "invalid"); + i_inactive_timeout = PQfnumber(res, "inactive_timeout"); for (int slotnum = 0; slotnum < num_slots; slotnum++) { @@ -716,6 +719,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) curr->failover = (strcmp(PQgetvalue(res, slotnum, i_failover), "t") == 0); curr->caught_up = (strcmp(PQgetvalue(res, slotnum, i_caught_up), "t") == 0); curr->invalid = (strcmp(PQgetvalue(res, slotnum, i_invalid), "t") == 0); + curr->inactive_timeout = atooid(PQgetvalue(res, slotnum, i_inactive_timeout)); } } diff --git a/src/bin/pg_upgrade/pg_upgrade.c b/src/bin/pg_upgrade/pg_upgrade.c index f6143b6bc4..2656056103 100644 --- a/src/bin/pg_upgrade/pg_upgrade.c +++ b/src/bin/pg_upgrade/pg_upgrade.c @@ -931,9 +931,10 @@ create_logical_replication_slots(void) appendPQExpBuffer(query, ", "); appendStringLiteralConn(query, slot_info->plugin, conn); - appendPQExpBuffer(query, ", false, %s, %s);", + appendPQExpBuffer(query, ", false, %s, %s, %d);", slot_info->two_phase ? "true" : "false", - slot_info->failover ? "true" : "false"); + slot_info->failover ? "true" : "false", + slot_info->inactive_timeout); PQclear(executeQueryOrDie(conn, "%s", query->data)); diff --git a/src/bin/pg_upgrade/pg_upgrade.h b/src/bin/pg_upgrade/pg_upgrade.h index 92bcb693fb..eb86d000b1 100644 --- a/src/bin/pg_upgrade/pg_upgrade.h +++ b/src/bin/pg_upgrade/pg_upgrade.h @@ -162,6 +162,8 @@ typedef struct bool invalid; /* if true, the slot is unusable */ bool failover; /* is the slot designated to be synced to the * physical standby? */ + int inactive_timeout; /* The amount of time in seconds the slot + * is allowed to be inactive. */ } LogicalSlotInfo; typedef struct diff --git a/src/bin/pg_upgrade/t/003_logical_slots.pl b/src/bin/pg_upgrade/t/003_logical_slots.pl index 83d71c3084..6e82d2cb7b 100644 --- a/src/bin/pg_upgrade/t/003_logical_slots.pl +++ b/src/bin/pg_upgrade/t/003_logical_slots.pl @@ -153,14 +153,17 @@ like( # TEST: Successful upgrade # Preparations for the subsequent test: -# 1. Setup logical replication (first, cleanup slots from the previous tests) +# 1. Setup logical replication (first, cleanup slots from the previous tests, +# and then create slot for this test with inactive_timeout set). my $old_connstr = $oldpub->connstr . ' dbname=postgres'; +my $inactive_timeout = 3600; $oldpub->start; $oldpub->safe_psql( 'postgres', qq[ SELECT * FROM pg_drop_replication_slot('test_slot1'); SELECT * FROM pg_drop_replication_slot('test_slot2'); + SELECT pg_create_logical_replication_slot(slot_name := 'regress_sub', plugin := 'pgoutput', inactive_timeout := $inactive_timeout); CREATE PUBLICATION regress_pub FOR ALL TABLES; ]); @@ -172,7 +175,7 @@ $sub->start; $sub->safe_psql( 'postgres', qq[ CREATE TABLE tbl (a int); - CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (two_phase = 'true', failover = 'true') + CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (slot_name = 'regress_sub', create_slot = false, two_phase = 'true', failover = 'true') ]); $sub->wait_for_subscription_sync($oldpub, 'regress_sub'); @@ -192,8 +195,8 @@ command_ok([@pg_upgrade_cmd], 'run of pg_upgrade of old cluster'); # Check that the slot 'regress_sub' has migrated to the new cluster $newpub->start; my $result = $newpub->safe_psql('postgres', - "SELECT slot_name, two_phase, failover FROM pg_replication_slots"); -is($result, qq(regress_sub|t|t), 'check the slot exists on new cluster'); + "SELECT slot_name, two_phase, failover, inactive_timeout = $inactive_timeout FROM pg_replication_slots"); +is($result, qq(regress_sub|t|t|t), 'check the slot exists on new cluster'); # Update the connection my $new_connstr = $newpub->connstr . ' dbname=postgres'; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 0d26e5b422..a09da44b6a 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11105,10 +11105,10 @@ # replication slots { oid => '3779', descr => 'create a physical replication slot', proname => 'pg_create_physical_replication_slot', provolatile => 'v', - proparallel => 'u', prorettype => 'record', proargtypes => 'name bool bool', - proallargtypes => '{name,bool,bool,name,pg_lsn}', - proargmodes => '{i,i,i,o,o}', - proargnames => '{slot_name,immediately_reserve,temporary,slot_name,lsn}', + proparallel => 'u', prorettype => 'record', proargtypes => 'name bool bool int4', + proallargtypes => '{name,bool,bool,int4,name,pg_lsn}', + proargmodes => '{i,i,i,i,o,o}', + proargnames => '{slot_name,immediately_reserve,temporary,inactive_timeout,slot_name,lsn}', prosrc => 'pg_create_physical_replication_slot' }, { oid => '4220', descr => 'copy a physical replication slot, changing temporality', @@ -11133,17 +11133,17 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,int4,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,inactive_timeout,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', proparallel => 'u', prorettype => 'record', - proargtypes => 'name name bool bool bool', - proallargtypes => '{name,name,bool,bool,bool,name,pg_lsn}', - proargmodes => '{i,i,i,i,i,o,o}', - proargnames => '{slot_name,plugin,temporary,twophase,failover,slot_name,lsn}', + proargtypes => 'name name bool bool bool int4', + proallargtypes => '{name,name,bool,bool,bool,int4,name,pg_lsn}', + proargmodes => '{i,i,i,i,i,i,o,o}', + proargnames => '{slot_name,plugin,temporary,twophase,failover,inactive_timeout,slot_name,lsn}', prosrc => 'pg_create_logical_replication_slot' }, { oid => '4222', descr => 'copy a logical replication slot, changing temporality and plugin', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 2f18433ecc..24623cfdc1 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -127,6 +127,9 @@ typedef struct ReplicationSlotPersistentData * for logical slots on the primary server. */ bool failover; + + /* The amount of time in seconds the slot is allowed to be inactive */ + int inactive_timeout; } ReplicationSlotPersistentData; /* @@ -239,7 +242,7 @@ extern void ReplicationSlotsShmemInit(void); extern void ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, bool two_phase, bool failover, - bool synced); + bool synced, int inactive_timeout); extern void ReplicationSlotPersist(void); extern void ReplicationSlotDrop(const char *name, bool nowait); extern void ReplicationSlotDropAcquired(void); diff --git a/src/test/recovery/t/040_standby_failover_slots_sync.pl b/src/test/recovery/t/040_standby_failover_slots_sync.pl index f47bfd78eb..3dd780beab 100644 --- a/src/test/recovery/t/040_standby_failover_slots_sync.pl +++ b/src/test/recovery/t/040_standby_failover_slots_sync.pl @@ -152,8 +152,9 @@ log_min_messages = 'debug2' $primary->append_conf('postgresql.conf', "log_min_messages = 'debug2'"); $primary->reload; +my $inactive_timeout = 3600; $primary->psql('postgres', - q{SELECT pg_create_logical_replication_slot('lsub2_slot', 'test_decoding', false, false, true);} + "SELECT pg_create_logical_replication_slot('lsub2_slot', 'test_decoding', false, false, true, $inactive_timeout);" ); $primary->psql('postgres', @@ -190,6 +191,16 @@ is( $standby1->safe_psql( "t", 'logical slots have synced as true on standby'); +# Confirm that the synced slot on the standby has got inactive_timeout from the +# primary. +is( $standby1->safe_psql( + 'postgres', + "SELECT inactive_timeout = $inactive_timeout FROM pg_replication_slots + WHERE slot_name = 'lsub2_slot' AND synced AND NOT temporary;" + ), + "t", + 'synced logical slot has got inactive_timeout on standby'); + ################################################## # Test that the synchronized slot will be dropped if the corresponding remote # slot on the primary server has been dropped. diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index dfcbaec387..d532e23176 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1474,11 +1474,12 @@ pg_replication_slots| SELECT l.slot_name, l.safe_wal_size, l.two_phase, l.last_inactive_time, + l.inactive_timeout, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, inactive_timeout, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 [application/octet-stream] v18-0003-Introduce-new-SQL-funtion-pg_alter_replication_s.patch (15.8K, ../../CALj2ACU6tV0bh_MiFBYU7-VK2cj8Gas73htcQjoOv0uvSEG_HA@mail.gmail.com/4-v18-0003-Introduce-new-SQL-funtion-pg_alter_replication_s.patch) download | inline diff: From 65be663680fbde9812392a4fa739633060625f82 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Sun, 24 Mar 2024 07:18:17 +0000 Subject: [PATCH v18 3/5] Introduce new SQL funtion pg_alter_replication_slot This commit adds a new function pg_alter_replication_slot to alter the given property of a replication slot. It is similar to replication protocol command ALTER_REPLICATION_SLOT, except that for now it allows only inactive_timeout property to be set. The reason for disallowing failover property to be altered via this function is to avoid inconsistency with the catalog pg_subscription on the logical subscriber. Because, the subscriber won't know the altered value of its replication slot on the publisher. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- contrib/test_decoding/expected/slot.out | 44 ++++++++++++++- contrib/test_decoding/sql/slot.sql | 10 ++++ doc/src/sgml/func.sgml | 21 ++++++++ src/backend/replication/slot.c | 22 ++++---- src/backend/replication/slotfuncs.c | 66 ++++++++++++++++++++++- src/bin/pg_upgrade/t/003_logical_slots.pl | 14 +++-- src/include/catalog/pg_proc.dat | 5 ++ src/include/replication/slot.h | 2 + 8 files changed, 167 insertions(+), 17 deletions(-) diff --git a/contrib/test_decoding/expected/slot.out b/contrib/test_decoding/expected/slot.out index 6771520afb..5b8dbf6f52 100644 --- a/contrib/test_decoding/expected/slot.out +++ b/contrib/test_decoding/expected/slot.out @@ -496,13 +496,27 @@ SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_sl copy (1 row) +-- Test alter physical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot4'); + ?column? +---------- + init +(1 row) + +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_phy_slot4', inactive_timeout := 900); + ?column? +---------- + alter +(1 row) + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; slot_name | slot_type | inactive_timeout --------------+-----------+------------------ it_phy_slot1 | physical | 300 it_phy_slot2 | physical | 0 it_phy_slot3 | physical | 300 -(3 rows) + it_phy_slot4 | physical | 900 +(4 rows) SELECT pg_drop_replication_slot('it_phy_slot1'); pg_drop_replication_slot @@ -522,6 +536,12 @@ SELECT pg_drop_replication_slot('it_phy_slot3'); (1 row) +SELECT pg_drop_replication_slot('it_phy_slot4'); + pg_drop_replication_slot +-------------------------- + +(1 row) + -- Test inactive_timeout option of logical slots. SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); ?column? @@ -542,13 +562,27 @@ SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slo copy (1 row) +-- Test alter logical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot4', plugin := 'test_decoding'); + ?column? +---------- + init +(1 row) + +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_log_slot4', inactive_timeout := 900); + ?column? +---------- + alter +(1 row) + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; slot_name | slot_type | inactive_timeout --------------+-----------+------------------ it_log_slot1 | logical | 600 it_log_slot2 | logical | 0 it_log_slot3 | logical | 600 -(3 rows) + it_log_slot4 | logical | 900 +(4 rows) SELECT pg_drop_replication_slot('it_log_slot1'); pg_drop_replication_slot @@ -568,3 +602,9 @@ SELECT pg_drop_replication_slot('it_log_slot3'); (1 row) +SELECT pg_drop_replication_slot('it_log_slot4'); + pg_drop_replication_slot +-------------------------- + +(1 row) + diff --git a/contrib/test_decoding/sql/slot.sql b/contrib/test_decoding/sql/slot.sql index 443e91da07..6785714cc7 100644 --- a/contrib/test_decoding/sql/slot.sql +++ b/contrib/test_decoding/sql/slot.sql @@ -206,11 +206,16 @@ SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot -- Copy physical slot with inactive_timeout option set. SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); +-- Test alter physical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot4'); +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_phy_slot4', inactive_timeout := 900); + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; SELECT pg_drop_replication_slot('it_phy_slot1'); SELECT pg_drop_replication_slot('it_phy_slot2'); SELECT pg_drop_replication_slot('it_phy_slot3'); +SELECT pg_drop_replication_slot('it_phy_slot4'); -- Test inactive_timeout option of logical slots. SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); @@ -219,8 +224,13 @@ SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2 -- Copy logical slot with inactive_timeout option set. SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); +-- Test alter logical slot with inactive_timeout option set. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot4', plugin := 'test_decoding'); +SELECT 'alter' FROM pg_alter_replication_slot(slot_name := 'it_log_slot4', inactive_timeout := 900); + SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; SELECT pg_drop_replication_slot('it_log_slot1'); SELECT pg_drop_replication_slot('it_log_slot2'); SELECT pg_drop_replication_slot('it_log_slot3'); +SELECT pg_drop_replication_slot('it_log_slot4'); diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index afaafa35ad..22c8e0d39c 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28829,6 +28829,27 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset </entry> </row> + <row> + <entry role="func_table_entry"><para role="func_signature"> + <indexterm> + <primary>pg_alter_replication_slot</primary> + </indexterm> + <function>pg_alter_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>inactive_timeout</parameter> <type>integer</type> ) + <returnvalue>void</returnvalue> + </para> + <para> + Alters the given property of a replication slot + named <parameter>slot_name</parameter>. Same as replication protocol + command <literal>ALTER_REPLICATION_SLOT</literal>, except that it + allows only <parameter>inactive_timeout</parameter> property to be set. + The reason for disallowing <parameter>failover</parameter> property to + be altered via this function is to avoid inconsistency with the catalog + <structname>pg_subscription</structname> on the logical subscriber. + Because, the subscriber won't know the altered value of its + replication slot on the publisher. + </para></entry> + </row> + </tbody> </tgroup> </table> diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 852a657e97..3287aa2860 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -162,7 +162,6 @@ static void ReplicationSlotDropPtr(ReplicationSlot *slot); /* internal persistency functions */ static void RestoreSlotFromDisk(const char *name); static void CreateSlotOnDisk(ReplicationSlot *slot); -static void SaveSlotToPath(ReplicationSlot *slot, const char *dir, int elevel); /* * Report shared-memory space needed by ReplicationSlotsShmemInit. @@ -870,6 +869,7 @@ ReplicationSlotAlter(const char *name, bool failover) ReplicationSlotRelease(); } + /* * Permanently drop the currently acquired replication slot. */ @@ -1005,7 +1005,7 @@ ReplicationSlotSave(void) Assert(MyReplicationSlot != NULL); sprintf(path, "pg_replslot/%s", NameStr(MyReplicationSlot->data.name)); - SaveSlotToPath(MyReplicationSlot, path, ERROR); + ReplicationSlotSaveToPath(MyReplicationSlot, path, ERROR); } /* @@ -1868,7 +1868,10 @@ CheckPointReplicationSlots(bool is_shutdown) if (!s->in_use) continue; - /* save the slot to disk, locking is handled in SaveSlotToPath() */ + /* + * Save the slot to disk, locking is handled in + * ReplicationSlotSaveToPath. + */ sprintf(path, "pg_replslot/%s", NameStr(s->data.name)); /* @@ -1894,7 +1897,7 @@ CheckPointReplicationSlots(bool is_shutdown) SpinLockRelease(&s->mutex); } - SaveSlotToPath(s, path, LOG); + ReplicationSlotSaveToPath(s, path, LOG); } LWLockRelease(ReplicationSlotAllocationLock); } @@ -1973,8 +1976,9 @@ CreateSlotOnDisk(ReplicationSlot *slot) /* * No need to take out the io_in_progress_lock, nobody else can see this - * slot yet, so nobody else will write. We're reusing SaveSlotToPath which - * takes out the lock, if we'd take the lock here, we'd deadlock. + * slot yet, so nobody else will write. We're reusing + * ReplicationSlotSaveToPath which takes out the lock, if we'd take the + * lock here, we'd deadlock. */ sprintf(path, "pg_replslot/%s", NameStr(slot->data.name)); @@ -2000,7 +2004,7 @@ CreateSlotOnDisk(ReplicationSlot *slot) /* Write the actual state file. */ slot->dirty = true; /* signal that we really need to write */ - SaveSlotToPath(slot, tmppath, ERROR); + ReplicationSlotSaveToPath(slot, tmppath, ERROR); /* Rename the directory into place. */ if (rename(tmppath, path) != 0) @@ -2025,8 +2029,8 @@ CreateSlotOnDisk(ReplicationSlot *slot) /* * Shared functionality between saving and creating a replication slot. */ -static void -SaveSlotToPath(ReplicationSlot *slot, const char *dir, int elevel) +void +ReplicationSlotSaveToPath(ReplicationSlot *slot, const char *dir, int elevel) { char tmppath[MAXPGPATH]; char path[MAXPGPATH]; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index fb79401c50..dba80ac1bb 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -229,7 +229,6 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) PG_RETURN_DATUM(result); } - /* * SQL function for dropping a replication slot. */ @@ -1038,3 +1037,68 @@ pg_sync_replication_slots(PG_FUNCTION_ARGS) PG_RETURN_VOID(); } + +/* + * SQL function for altering given properties of a replication slot. + */ +Datum +pg_alter_replication_slot(PG_FUNCTION_ARGS) +{ + Name name = PG_GETARG_NAME(0); + int inactive_timeout = PG_GETARG_INT32(1); + ReplicationSlot *slot; + char path[MAXPGPATH]; + + CheckSlotPermissions(); + + CheckSlotRequirements(); + + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + /* Check if the slot exits with the given name. */ + slot = SearchNamedReplicationSlot(NameStr(*name), false); + + if (!slot) + ereport(ERROR, + (errcode(ERRCODE_INVALID_PARAMETER_VALUE), + errmsg("replication slot \"%s\" does not exist", + NameStr(*name)))); + + /* + * Do not allow users to set inactive_timeout for temporary slots because + * temporary, slots will not be saved to the disk. + */ + if (slot->data.persistency == RS_TEMPORARY) + ereport(ERROR, + errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("cannot set inactive_timeout for a temporary replication slot")); + + LWLockRelease(ReplicationSlotControlLock); + + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + + /* + * We need to briefly prevent any other backend from acquiring the slot + * while we set the property. Without holding the ControlLock exclusively, + * a concurrent ReplicationSlotAcquire() could acquire the slot as well. + */ + LWLockAcquire(ReplicationSlotControlLock, LW_EXCLUSIVE); + + SpinLockAcquire(&slot->mutex); + slot->data.inactive_timeout = inactive_timeout; + + /* Make sure the invalidated state persists across server restart */ + slot->just_dirtied = true; + slot->dirty = true; + SpinLockRelease(&slot->mutex); + + sprintf(path, "pg_replslot/%s", NameStr(slot->data.name)); + ReplicationSlotSaveToPath(slot, path, ERROR); + + LWLockRelease(ReplicationSlotControlLock); + + PG_RETURN_VOID(); +} diff --git a/src/bin/pg_upgrade/t/003_logical_slots.pl b/src/bin/pg_upgrade/t/003_logical_slots.pl index 6e82d2cb7b..b79db24f42 100644 --- a/src/bin/pg_upgrade/t/003_logical_slots.pl +++ b/src/bin/pg_upgrade/t/003_logical_slots.pl @@ -153,17 +153,14 @@ like( # TEST: Successful upgrade # Preparations for the subsequent test: -# 1. Setup logical replication (first, cleanup slots from the previous tests, -# and then create slot for this test with inactive_timeout set). +# 1. Setup logical replication (first, cleanup slots from the previous tests) my $old_connstr = $oldpub->connstr . ' dbname=postgres'; -my $inactive_timeout = 3600; $oldpub->start; $oldpub->safe_psql( 'postgres', qq[ SELECT * FROM pg_drop_replication_slot('test_slot1'); SELECT * FROM pg_drop_replication_slot('test_slot2'); - SELECT pg_create_logical_replication_slot(slot_name := 'regress_sub', plugin := 'pgoutput', inactive_timeout := $inactive_timeout); CREATE PUBLICATION regress_pub FOR ALL TABLES; ]); @@ -175,7 +172,7 @@ $sub->start; $sub->safe_psql( 'postgres', qq[ CREATE TABLE tbl (a int); - CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (slot_name = 'regress_sub', create_slot = false, two_phase = 'true', failover = 'true') + CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (two_phase = 'true', failover = 'true') ]); $sub->wait_for_subscription_sync($oldpub, 'regress_sub'); @@ -185,6 +182,13 @@ my $twophase_query = $sub->poll_query_until('postgres', $twophase_query) or die "Timed out while waiting for subscriber to enable twophase"; +# Alter slot to set inactive_timeout +my $inactive_timeout = 3600; +$oldpub->safe_psql( + 'postgres', qq[ + SELECT pg_alter_replication_slot(slot_name := 'regress_sub', inactive_timeout := $inactive_timeout); +]); + # 2. Temporarily disable the subscription $sub->safe_psql('postgres', "ALTER SUBSCRIPTION regress_sub DISABLE"); $oldpub->stop; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index a09da44b6a..9a8134aa46 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11222,6 +11222,11 @@ proname => 'pg_sync_replication_slots', provolatile => 'v', proparallel => 'u', prorettype => 'void', proargtypes => '', prosrc => 'pg_sync_replication_slots' }, +{ oid => '9039', descr => 'alter given properties of a replication slot', + proname => 'pg_alter_replication_slot', provolatile => 'v', proparallel => 'u', + prorettype => 'void', proargtypes => 'name int4', + proargnames => '{slot_name,inactive_timeout}', + prosrc => 'pg_alter_replication_slot' }, # event triggers { oid => '3566', descr => 'list objects dropped by the current command', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 24623cfdc1..915edf7617 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -252,6 +252,8 @@ extern void ReplicationSlotAcquire(const char *name, bool nowait); extern void ReplicationSlotRelease(void); extern void ReplicationSlotCleanup(void); extern void ReplicationSlotSave(void); +extern void ReplicationSlotSaveToPath(ReplicationSlot *slot, const char *dir, + int elevel); extern void ReplicationSlotMarkDirty(void); /* misc stuff */ -- 2.34.1 [application/octet-stream] v18-0004-Allow-setting-inactive_timeout-in-the-replicatio.patch (10.5K, ../../CALj2ACU6tV0bh_MiFBYU7-VK2cj8Gas73htcQjoOv0uvSEG_HA@mail.gmail.com/5-v18-0004-Allow-setting-inactive_timeout-in-the-replicatio.patch) download | inline diff: From a1062c4c527693c6980dc2b63c5091eed19438e7 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Sun, 24 Mar 2024 08:08:24 +0000 Subject: [PATCH v18 4/5] Allow setting inactive_timeout in the replication commands. This commit allows replication connections to be able to set inactive_timeout property of the slot using replication commands CREATE_REPLICATION_SLOT and ALTER_REPLICATION_SLOT. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila, Ajin Cherian Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/protocol.sgml | 20 +++++++++++ src/backend/replication/slot.c | 31 +++++++++++++++-- src/backend/replication/walsender.c | 38 ++++++++++++++++---- src/include/replication/slot.h | 3 +- src/test/recovery/t/001_stream_rep.pl | 50 +++++++++++++++++++++++++++ 5 files changed, 132 insertions(+), 10 deletions(-) diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index a5cb19357f..2ffa1b470a 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -2068,6 +2068,16 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" </para> </listitem> </varlistentry> + + <varlistentry> + <term><literal>INACTIVE_TIMEOUT [ <replaceable class="parameter">integer</replaceable> ]</literal></term> + <listitem> + <para> + If set to a non-zero value, specifies the amount of time in seconds + the slot is allowed to be inactive. The default is zero. + </para> + </listitem> + </varlistentry> </variablelist> <para> @@ -2168,6 +2178,16 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" </para> </listitem> </varlistentry> + + <varlistentry> + <term><literal>INACTIVE_TIMEOUT [ <replaceable class="parameter">integer</replaceable> ]</literal></term> + <listitem> + <para> + If set to a non-zero value, specifies the amount of time in seconds + the slot is allowed to be inactive. The default is zero. + </para> + </listitem> + </varlistentry> </variablelist> </listitem> diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 3287aa2860..baf0b9aa72 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -812,8 +812,10 @@ ReplicationSlotDrop(const char *name, bool nowait) * Change the definition of the slot identified by the specified name. */ void -ReplicationSlotAlter(const char *name, bool failover) +ReplicationSlotAlter(const char *name, bool failover, int inactive_timeout) { + bool lock_acquired; + Assert(MyReplicationSlot == NULL); ReplicationSlotAcquire(name, false); @@ -856,10 +858,35 @@ ReplicationSlotAlter(const char *name, bool failover) errcode(ERRCODE_FEATURE_NOT_SUPPORTED), errmsg("cannot enable failover for a temporary replication slot")); - if (MyReplicationSlot->data.failover != failover) + /* + * Do not allow users to set inactive_timeout for temporary slots because + * temporary, slots will not be saved to the disk. + */ + if (inactive_timeout > 0 && MyReplicationSlot->data.persistency == RS_TEMPORARY) + ereport(ERROR, + errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("cannot set inactive_timeout for a temporary replication slot")); + + /* + * If we are to change any of the slot property, acquire the lock once and + * for all. + */ + lock_acquired = false; + if (MyReplicationSlot->data.failover != failover || + MyReplicationSlot->data.inactive_timeout != inactive_timeout) { SpinLockAcquire(&MyReplicationSlot->mutex); + lock_acquired = true; + } + + if (MyReplicationSlot->data.failover != failover) MyReplicationSlot->data.failover = failover; + + if (MyReplicationSlot->data.inactive_timeout != inactive_timeout) + MyReplicationSlot->data.inactive_timeout = inactive_timeout; + + if (lock_acquired) + { SpinLockRelease(&MyReplicationSlot->mutex); ReplicationSlotMarkDirty(); diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 5315c08650..0420274247 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -1123,13 +1123,15 @@ static void parseCreateReplSlotOptions(CreateReplicationSlotCmd *cmd, bool *reserve_wal, CRSSnapshotAction *snapshot_action, - bool *two_phase, bool *failover) + bool *two_phase, bool *failover, + int *inactive_timeout) { ListCell *lc; bool snapshot_action_given = false; bool reserve_wal_given = false; bool two_phase_given = false; bool failover_given = false; + bool inactive_timeout_given = false; /* Parse options */ foreach(lc, cmd->options) @@ -1188,6 +1190,15 @@ parseCreateReplSlotOptions(CreateReplicationSlotCmd *cmd, failover_given = true; *failover = defGetBoolean(defel); } + else if (strcmp(defel->defname, "inactive_timeout") == 0) + { + if (inactive_timeout_given) + ereport(ERROR, + (errcode(ERRCODE_SYNTAX_ERROR), + errmsg("conflicting or redundant options"))); + inactive_timeout_given = true; + *inactive_timeout = defGetInt32(defel); + } else elog(ERROR, "unrecognized option: %s", defel->defname); } @@ -1205,6 +1216,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) bool reserve_wal = false; bool two_phase = false; bool failover = false; + int inactive_timeout = 0; CRSSnapshotAction snapshot_action = CRS_EXPORT_SNAPSHOT; DestReceiver *dest; TupOutputState *tstate; @@ -1215,13 +1227,13 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) Assert(!MyReplicationSlot); parseCreateReplSlotOptions(cmd, &reserve_wal, &snapshot_action, &two_phase, - &failover); + &failover, &inactive_timeout); if (cmd->kind == REPLICATION_KIND_PHYSICAL) { ReplicationSlotCreate(cmd->slotname, false, cmd->temporary ? RS_TEMPORARY : RS_PERSISTENT, - false, false, false, 0); + false, false, false, inactive_timeout); if (reserve_wal) { @@ -1252,7 +1264,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) */ ReplicationSlotCreate(cmd->slotname, true, cmd->temporary ? RS_TEMPORARY : RS_EPHEMERAL, - two_phase, failover, false, 0); + two_phase, failover, false, inactive_timeout); /* * Do options check early so that we can bail before calling the @@ -1411,9 +1423,11 @@ DropReplicationSlot(DropReplicationSlotCmd *cmd) * Process extra options given to ALTER_REPLICATION_SLOT. */ static void -ParseAlterReplSlotOptions(AlterReplicationSlotCmd *cmd, bool *failover) +ParseAlterReplSlotOptions(AlterReplicationSlotCmd *cmd, bool *failover, + int *inactive_timeout) { bool failover_given = false; + bool inactive_timeout_given = false; /* Parse options */ foreach_ptr(DefElem, defel, cmd->options) @@ -1427,6 +1441,15 @@ ParseAlterReplSlotOptions(AlterReplicationSlotCmd *cmd, bool *failover) failover_given = true; *failover = defGetBoolean(defel); } + else if (strcmp(defel->defname, "inactive_timeout") == 0) + { + if (inactive_timeout_given) + ereport(ERROR, + (errcode(ERRCODE_SYNTAX_ERROR), + errmsg("conflicting or redundant options"))); + inactive_timeout_given = true; + *inactive_timeout = defGetInt32(defel); + } else elog(ERROR, "unrecognized option: %s", defel->defname); } @@ -1439,9 +1462,10 @@ static void AlterReplicationSlot(AlterReplicationSlotCmd *cmd) { bool failover = false; + int inactive_timeout = 0; - ParseAlterReplSlotOptions(cmd, &failover); - ReplicationSlotAlter(cmd->slotname, failover); + ParseAlterReplSlotOptions(cmd, &failover, &inactive_timeout); + ReplicationSlotAlter(cmd->slotname, failover, inactive_timeout); } /* diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 915edf7617..ee9b385cf9 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -246,7 +246,8 @@ extern void ReplicationSlotCreate(const char *name, bool db_specific, extern void ReplicationSlotPersist(void); extern void ReplicationSlotDrop(const char *name, bool nowait); extern void ReplicationSlotDropAcquired(void); -extern void ReplicationSlotAlter(const char *name, bool failover); +extern void ReplicationSlotAlter(const char *name, bool failover, + int inactive_timeout); extern void ReplicationSlotAcquire(const char *name, bool nowait); extern void ReplicationSlotRelease(void); diff --git a/src/test/recovery/t/001_stream_rep.pl b/src/test/recovery/t/001_stream_rep.pl index 5311ade509..db00b6aa24 100644 --- a/src/test/recovery/t/001_stream_rep.pl +++ b/src/test/recovery/t/001_stream_rep.pl @@ -604,4 +604,54 @@ ok( pump_until( 'base backup cleanly canceled'); $sigchld_bb->finish(); +# Drop any existing slots on the primary, for the follow-up tests. +$node_primary->safe_psql('postgres', + "SELECT pg_drop_replication_slot(slot_name) FROM pg_replication_slots;"); + +# Test setting inactive_timeout option via replication commands. +$node_primary->append_conf( + 'postgresql.conf', qq( +wal_level = logical +)); +$node_primary->restart; + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_phy_slot1 PHYSICAL (RESERVE_WAL, INACTIVE_TIMEOUT 100);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_phy_slot2 PHYSICAL (RESERVE_WAL);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "ALTER_REPLICATION_SLOT it_phy_slot2 (INACTIVE_TIMEOUT 200);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_log_slot1 LOGICAL pgoutput (TWO_PHASE, INACTIVE_TIMEOUT 300);", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "CREATE_REPLICATION_SLOT it_log_slot2 LOGICAL pgoutput;", + extra_params => [ '-d', $connstr_db ]); + +$node_primary->psql( + 'postgres', + "ALTER_REPLICATION_SLOT it_log_slot2 (INACTIVE_TIMEOUT 400);", + extra_params => [ '-d', $connstr_db ]); + +my $slot_info_expected = 'it_log_slot1|logical|300 +it_log_slot2|logical|400 +it_phy_slot1|physical|100 +it_phy_slot2|physical|0'; + +my $slot_info = $node_primary->safe_psql('postgres', + qq[SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1;]); +is($slot_info, $slot_info_expected, "replication slots with inactive_timeout on primary exist"); + done_testing(); -- 2.34.1 [application/octet-stream] v18-0005-Add-inactive_timeout-based-replication-slot-inva.patch (26.2K, ../../CALj2ACU6tV0bh_MiFBYU7-VK2cj8Gas73htcQjoOv0uvSEG_HA@mail.gmail.com/6-v18-0005-Add-inactive_timeout-based-replication-slot-inva.patch) download | inline diff: From 2e1a8cba688291cf9150f0abbce89273832a644d Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Sun, 24 Mar 2024 08:48:41 +0000 Subject: [PATCH v18 5/5] Add inactive_timeout based replication slot invalidation. Till now, postgres has the ability to invalidate inactive replication slots based on the amount of WAL (set via max_slot_wal_keep_size GUC) that will be needed for the slots in case they become active. However, choosing a default value for max_slot_wal_keep_size is tricky. Because the amount of WAL a customer generates, and their allocated storage will vary greatly in production, making it difficult to pin down a one-size-fits-all value. It is often easy for developers to set a timeout of say 1 or 2 or 3 days at slot level, after which the inactive slots get dropped. To achieve the above, postgres uses replication slot property last_inactive_time (the time at which the slot became inactive), and a new slot level parameter inactive_timeout and finds an opportunity to invalidate the slot based on this new mechanism. The invalidation check happens at various locations to help being as latest as possible, these locations include the following: - Whenever the slot is acquired if the slot gets invalidated due to this new mechanism, an error is emitted. - During checkpoint. - Whenver pg_get_replication_slots() is called. Note that this new invalidation mechanism won't kick-in for the slots that are currently being synced from the primary to the standby. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/func.sgml | 12 +- doc/src/sgml/system-views.sgml | 10 +- .../replication/logical/logicalfuncs.c | 2 +- src/backend/replication/logical/slotsync.c | 4 +- src/backend/replication/slot.c | 184 +++++++++++++++++- src/backend/replication/slotfuncs.c | 19 +- src/backend/replication/walsender.c | 4 +- src/backend/utils/adt/pg_upgrade_support.c | 2 +- src/include/replication/slot.h | 9 +- src/test/recovery/meson.build | 1 + src/test/recovery/t/050_invalidate_slots.pl | 170 ++++++++++++++++ 11 files changed, 395 insertions(+), 22 deletions(-) create mode 100644 src/test/recovery/t/050_invalidate_slots.pl diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 22c8e0d39c..4826e45c7d 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28393,8 +28393,8 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset released upon any error. The optional fourth parameter, <parameter>inactive_timeout</parameter>, when set to a non-zero value, specifies the amount of time in seconds the slot is - allowed to be inactive. This function corresponds to the replication - protocol command + allowed to be inactive before getting invalidated. + This function corresponds to the replication protocol command <literal>CREATE_REPLICATION_SLOT ... PHYSICAL</literal>. </para></entry> </row> @@ -28439,12 +28439,12 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <parameter>failover</parameter>, when set to true, specifies that this slot is enabled to be synced to the standbys so that logical replication can be resumed after - failover. The optional sixth parameter, + failover. The optional sixth parameter, <parameter>inactive_timeout</parameter>, when set to a non-zero value, specifies the amount of time in seconds the slot is - allowed to be inactive. A call to this function has the same effect as - the replication protocol command - <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. + allowed to be inactive before getting invalidated. + A call to this function has the same effect as the replication protocol + command <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. </para></entry> </row> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index dddbaa070f..1722609d39 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2539,7 +2539,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <structfield>inactive_timeout</structfield> <type>integer</type> </para> <para> - The amount of time in seconds the slot is allowed to be inactive. + The amount of time in seconds the slot is allowed to be inactive + before getting invalidated. </para></entry> </row> @@ -2583,6 +2584,13 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx perform logical decoding. It is set only for logical slots. </para> </listitem> + <listitem> + <para> + <literal>inactive_timeout</literal> means that the slot has been + inactive for the duration specified by slot's + <literal>inactive_timeout</literal> parameter. + </para> + </listitem> </itemizedlist> </para></entry> </row> diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index b4dd5cce75..56fc1a45a9 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -197,7 +197,7 @@ pg_logical_slot_get_changes_guts(FunctionCallInfo fcinfo, bool confirm, bool bin else end_of_wal = GetXLogReplayRecPtr(NULL); - ReplicationSlotAcquire(NameStr(*name), true); + ReplicationSlotAcquire(NameStr(*name), true, true); PG_TRY(); { diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index c01876ceeb..7f1ffab23c 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -319,7 +319,7 @@ drop_local_obsolete_slots(List *remote_slot_list) if (synced_slot) { - ReplicationSlotAcquire(NameStr(local_slot->data.name), true); + ReplicationSlotAcquire(NameStr(local_slot->data.name), true, false); ReplicationSlotDropAcquired(); } @@ -529,7 +529,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) * InvalidatePossiblyObsoleteSlot() where it invalidates slot directly * if the slot is not acquired by other processes. */ - ReplicationSlotAcquire(remote_slot->name, true); + ReplicationSlotAcquire(remote_slot->name, true, false); Assert(slot == MyReplicationSlot); diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index baf0b9aa72..fae61020c4 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -107,10 +107,11 @@ const char *const SlotInvalidationCauses[] = { [RS_INVAL_WAL_REMOVED] = "wal_removed", [RS_INVAL_HORIZON] = "rows_removed", [RS_INVAL_WAL_LEVEL] = "wal_level_insufficient", + [RS_INVAL_INACTIVE_TIMEOUT] = "inactive_timeout", }; /* Maximum number of invalidation causes */ -#define RS_INVAL_MAX_CAUSES RS_INVAL_WAL_LEVEL +#define RS_INVAL_MAX_CAUSES RS_INVAL_INACTIVE_TIMEOUT StaticAssertDecl(lengthof(SlotInvalidationCauses) == (RS_INVAL_MAX_CAUSES + 1), "array length mismatch"); @@ -158,6 +159,9 @@ static XLogRecPtr ss_oldest_flush_lsn = InvalidXLogRecPtr; static void ReplicationSlotShmemExit(int code, Datum arg); static void ReplicationSlotDropPtr(ReplicationSlot *slot); +static bool InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex); /* internal persistency functions */ static void RestoreSlotFromDisk(const char *name); @@ -550,9 +554,14 @@ ReplicationSlotName(int index, Name name) * * An error is raised if nowait is true and the slot is currently in use. If * nowait is false, we sleep until the slot is released by the owning process. + * + * If check_for_invalidation is true, the slot is checked for invalidation + * based on its inactive_timeout parameter and an error is raised after making + * the slot ours. */ void -ReplicationSlotAcquire(const char *name, bool nowait) +ReplicationSlotAcquire(const char *name, bool nowait, + bool check_for_invalidation) { ReplicationSlot *s; int active_pid; @@ -630,6 +639,42 @@ retry: /* We made this slot active, so it's ours now. */ MyReplicationSlot = s; + /* + * Check if the given slot can be invalidated based on its + * inactive_timeout parameter. If yes, persist the invalidated state to + * disk and then error out. We do this only after making the slot ours to + * avoid anyone else acquiring it while we check for its invalidation. + */ + if (check_for_invalidation) + { + /* The slot is ours by now */ + Assert(s->active_pid == MyProcPid); + + /* + * Well, the slot is not yet ours really unless we check for the + * invalidation below. + */ + s->active_pid = 0; + if (InvalidateReplicationSlotForInactiveTimeout(s, true, true, true)) + { + /* + * If the slot has been invalidated, recalculate the resource + * limits. + */ + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + + /* Might need it for slot clean up on error, so restore it */ + s->active_pid = MyProcPid; + ereport(ERROR, + (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), + errmsg("cannot acquire invalidated replication slot \"%s\"", + NameStr(MyReplicationSlot->data.name)), + errdetail("This slot has been invalidated because of its inactive_timeout parameter."))); + } + s->active_pid = MyProcPid; + } + /* * The call to pgstat_acquire_replslot() protects against stats for a * different slot, from before a restart or such, being present during @@ -793,7 +838,7 @@ ReplicationSlotDrop(const char *name, bool nowait) { Assert(MyReplicationSlot == NULL); - ReplicationSlotAcquire(name, nowait); + ReplicationSlotAcquire(name, nowait, false); /* * Do not allow users to drop the slots which are currently being synced @@ -818,7 +863,7 @@ ReplicationSlotAlter(const char *name, bool failover, int inactive_timeout) Assert(MyReplicationSlot == NULL); - ReplicationSlotAcquire(name, false); + ReplicationSlotAcquire(name, false, true); if (SlotIsPhysical(MyReplicationSlot)) ereport(ERROR, @@ -1546,6 +1591,9 @@ ReportSlotInvalidation(ReplicationSlotInvalidationCause cause, case RS_INVAL_WAL_LEVEL: appendStringInfoString(&err_detail, _("Logical decoding on standby requires wal_level >= logical on the primary server.")); break; + case RS_INVAL_INACTIVE_TIMEOUT: + appendStringInfoString(&err_detail, _("The slot has been inactive for more than the time specified by slot's inactive_timeout parameter.")); + break; case RS_INVAL_NONE: pg_unreachable(); } @@ -1659,6 +1707,10 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, if (SlotIsLogical(s)) invalidation_cause = cause; break; + case RS_INVAL_INACTIVE_TIMEOUT: + if (InvalidateReplicationSlotForInactiveTimeout(s, false, false, false)) + invalidation_cause = cause; + break; case RS_INVAL_NONE: pg_unreachable(); } @@ -1812,6 +1864,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, * - RS_INVAL_HORIZON: requires a snapshot <= the given horizon in the given * db; dboid may be InvalidOid for shared relations * - RS_INVAL_WAL_LEVEL: is logical + * - RS_INVAL_INACTIVE_TIMEOUT: inactive slot timeout occurs * * NB - this runs as part of checkpoint, so avoid raising errors if possible. */ @@ -1863,6 +1916,109 @@ restart: return invalidated; } +/* + * Invalidate given slot based on its inactive_timeout parameter. + * + * Returns true if the slot has got invalidated. + * + * NB - this function also runs as part of checkpoint, so avoid raising errors + * if possible. + */ +bool +InvalidateReplicationSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex, + bool persist_state) +{ + if (!InvalidateSlotForInactiveTimeout(slot, need_control_lock, need_mutex)) + return false; + + Assert(slot->active_pid == 0); + + SpinLockAcquire(&slot->mutex); + slot->data.invalidated = RS_INVAL_INACTIVE_TIMEOUT; + + /* Make sure the invalidated state persists across server restart */ + slot->just_dirtied = true; + slot->dirty = true; + SpinLockRelease(&slot->mutex); + + if (persist_state) + { + char path[MAXPGPATH]; + + sprintf(path, "pg_replslot/%s", NameStr(slot->data.name)); + ReplicationSlotSaveToPath(slot, path, ERROR); + } + + ReportSlotInvalidation(RS_INVAL_INACTIVE_TIMEOUT, false, 0, + slot->data.name, InvalidXLogRecPtr, + InvalidXLogRecPtr, InvalidTransactionId); + + return true; +} + +/* + * Helper for InvalidateReplicationSlotForInactiveTimeout + */ +static bool +InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex) +{ + ReplicationSlotInvalidationCause inavidation_cause = RS_INVAL_NONE; + + if (slot->last_inactive_time == 0 || + slot->data.inactive_timeout == 0) + return false; + + /* inactive_timeout is only tracked for permanent slots */ + if (slot->data.persistency != RS_PERSISTENT) + return false; + + /* + * Do not invalidate the slots which are currently being synced from the + * primary to the standby. + */ + if (RecoveryInProgress() && slot->data.synced) + return false; + + if (need_control_lock) + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); + + /* + * Check if the slot needs to be invalidated due to inactive_timeout. We + * do this with the spinlock held to avoid race conditions -- for example + * the restart_lsn could move forward, or the slot could be dropped. + */ + if (need_mutex) + SpinLockAcquire(&slot->mutex); + + if (slot->last_inactive_time > 0 && + slot->data.inactive_timeout > 0) + { + TimestampTz now; + + /* last_inactive_time is only tracked for inactive slots */ + Assert(slot->active_pid == 0); + + now = GetCurrentTimestamp(); + if (TimestampDifferenceExceeds(slot->last_inactive_time, now, + slot->data.inactive_timeout * 1000)) + inavidation_cause = RS_INVAL_INACTIVE_TIMEOUT; + } + + if (need_mutex) + SpinLockRelease(&slot->mutex); + + if (need_control_lock) + LWLockRelease(ReplicationSlotControlLock); + + return (inavidation_cause == RS_INVAL_INACTIVE_TIMEOUT); +} + /* * Flush all replication slots to disk. * @@ -1875,6 +2031,7 @@ void CheckPointReplicationSlots(bool is_shutdown) { int i; + bool invalidated = false; elog(DEBUG1, "performing replication slot checkpoint"); @@ -1896,10 +2053,11 @@ CheckPointReplicationSlots(bool is_shutdown) continue; /* - * Save the slot to disk, locking is handled in - * ReplicationSlotSaveToPath. + * Here's an opportunity to invalidate inactive replication slots + * based on timeout, so let's do it. */ - sprintf(path, "pg_replslot/%s", NameStr(s->data.name)); + if (InvalidateReplicationSlotForInactiveTimeout(s, true, true, false)) + invalidated = true; /* * Slot's data is not flushed each time the confirmed_flush LSN is @@ -1924,9 +2082,21 @@ CheckPointReplicationSlots(bool is_shutdown) SpinLockRelease(&s->mutex); } + /* + * Save the slot to disk, locking is handled in + * ReplicationSlotSaveToPath. + */ + sprintf(path, "pg_replslot/%s", NameStr(s->data.name)); ReplicationSlotSaveToPath(s, path, LOG); } LWLockRelease(ReplicationSlotAllocationLock); + + /* If the slot has been invalidated, recalculate the resource limits */ + if (invalidated) + { + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + } } /* diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index dba80ac1bb..aadba68c11 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -257,6 +257,7 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; + bool invalidated = false; /* * We don't require any special permission to see this function's data @@ -287,6 +288,13 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) slot_contents = *slot; SpinLockRelease(&slot->mutex); + /* + * Here's an opportunity to invalidate inactive replication slots + * based on timeout, so let's do it. + */ + if (InvalidateReplicationSlotForInactiveTimeout(slot, false, true, true)) + invalidated = true; + memset(values, 0, sizeof(values)); memset(nulls, 0, sizeof(nulls)); @@ -465,6 +473,15 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) LWLockRelease(ReplicationSlotControlLock); + /* + * If the slot has been invalidated, recalculate the resource limits + */ + if (invalidated) + { + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + } + return (Datum) 0; } @@ -667,7 +684,7 @@ pg_replication_slot_advance(PG_FUNCTION_ARGS) moveto = Min(moveto, GetXLogReplayRecPtr(NULL)); /* Acquire the slot so we "own" it */ - ReplicationSlotAcquire(NameStr(*slotname), true); + ReplicationSlotAcquire(NameStr(*slotname), true, true); /* A slot whose restart_lsn has never been reserved cannot be advanced */ if (XLogRecPtrIsInvalid(MyReplicationSlot->data.restart_lsn)) diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 0420274247..aa886412a5 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -846,7 +846,7 @@ StartReplication(StartReplicationCmd *cmd) if (cmd->slotname) { - ReplicationSlotAcquire(cmd->slotname, true); + ReplicationSlotAcquire(cmd->slotname, true, true); if (SlotIsLogical(MyReplicationSlot)) ereport(ERROR, (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), @@ -1483,7 +1483,7 @@ StartLogicalReplication(StartReplicationCmd *cmd) Assert(!MyReplicationSlot); - ReplicationSlotAcquire(cmd->slotname, true); + ReplicationSlotAcquire(cmd->slotname, true, true); /* * Force a disconnect, so that the decoding code doesn't need to care diff --git a/src/backend/utils/adt/pg_upgrade_support.c b/src/backend/utils/adt/pg_upgrade_support.c index c54b08fe18..82956d58d3 100644 --- a/src/backend/utils/adt/pg_upgrade_support.c +++ b/src/backend/utils/adt/pg_upgrade_support.c @@ -299,7 +299,7 @@ binary_upgrade_logical_slot_has_caught_up(PG_FUNCTION_ARGS) slot_name = PG_GETARG_NAME(0); /* Acquire the given slot */ - ReplicationSlotAcquire(NameStr(*slot_name), true); + ReplicationSlotAcquire(NameStr(*slot_name), true, false); Assert(SlotIsLogical(MyReplicationSlot)); diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index ee9b385cf9..00ff8e5ef5 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -53,6 +53,8 @@ typedef enum ReplicationSlotInvalidationCause RS_INVAL_HORIZON, /* wal_level insufficient for slot */ RS_INVAL_WAL_LEVEL, + /* inactive slot timeout has occurred */ + RS_INVAL_INACTIVE_TIMEOUT, } ReplicationSlotInvalidationCause; extern PGDLLIMPORT const char *const SlotInvalidationCauses[]; @@ -249,7 +251,8 @@ extern void ReplicationSlotDropAcquired(void); extern void ReplicationSlotAlter(const char *name, bool failover, int inactive_timeout); -extern void ReplicationSlotAcquire(const char *name, bool nowait); +extern void ReplicationSlotAcquire(const char *name, bool nowait, + bool check_for_invalidation); extern void ReplicationSlotRelease(void); extern void ReplicationSlotCleanup(void); extern void ReplicationSlotSave(void); @@ -270,6 +273,10 @@ extern bool InvalidateObsoleteReplicationSlots(ReplicationSlotInvalidationCause XLogSegNo oldestSegno, Oid dboid, TransactionId snapshotConflictHorizon); +extern bool InvalidateReplicationSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex, + bool persist_state); extern ReplicationSlot *SearchNamedReplicationSlot(const char *name, bool need_lock); extern int ReplicationSlotIndex(ReplicationSlot *slot); extern bool ReplicationSlotName(int index, Name name); diff --git a/src/test/recovery/meson.build b/src/test/recovery/meson.build index b1eb77b1ec..708a2a3798 100644 --- a/src/test/recovery/meson.build +++ b/src/test/recovery/meson.build @@ -51,6 +51,7 @@ tests += { 't/040_standby_failover_slots_sync.pl', 't/041_checkpoint_at_promote.pl', 't/042_low_level_backup.pl', + 't/050_invalidate_slots.pl', ], }, } diff --git a/src/test/recovery/t/050_invalidate_slots.pl b/src/test/recovery/t/050_invalidate_slots.pl new file mode 100644 index 0000000000..77499dde07 --- /dev/null +++ b/src/test/recovery/t/050_invalidate_slots.pl @@ -0,0 +1,170 @@ +# Copyright (c) 2024, PostgreSQL Global Development Group + +# Test for replication slots invalidation +use strict; +use warnings FATAL => 'all'; + +use PostgreSQL::Test::Utils; +use PostgreSQL::Test::Cluster; +use Test::More; +use Time::HiRes qw(usleep); + +# Check for invalidation of slot in server log. +sub check_slots_invalidation_in_server_log +{ + my ($node, $slot_name, $offset) = @_; + my $invalidated = 0; + + for (my $i = 0; $i < 10 * $PostgreSQL::Test::Utils::timeout_default; $i++) + { + $node->safe_psql('postgres', "CHECKPOINT"); + if ($node->log_contains( + "invalidating obsolete replication slot \"$slot_name\"", $offset)) + { + $invalidated = 1; + last; + } + usleep(100_000); + } + ok($invalidated, "check that slot $slot_name invalidation has been logged"); +} + +# ============================================================================= +# Testcase start: Invalidate streaming standby's slot due to inactive_timeout +# + +# Initialize primary node +my $primary = PostgreSQL::Test::Cluster->new('primary'); +$primary->init(allows_streaming => 'logical'); + +# Avoid checkpoint during the test, otherwise, the test can get unpredictable +$primary->append_conf( + 'postgresql.conf', q{ +checkpoint_timeout = 1h +autovacuum = off +}); +$primary->start; + +# Take backup +my $backup_name = 'my_backup'; +$primary->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby1 = PostgreSQL::Test::Cluster->new('standby1'); +$standby1->init_from_backup($primary, $backup_name, has_streaming => 1); +$standby1->append_conf( + 'postgresql.conf', q{ +primary_slot_name = 'sb1_slot' +}); + +# Set timeout so that the slot when inactive will get invalidated after the +# timeout. +my $inactive_timeout = 1; +$primary->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := 'sb1_slot', inactive_timeout := $inactive_timeout); +]); + +$standby1->start; + +# Wait until standby has replayed enough data +$primary->wait_for_catchup($standby1); + +# Check inactive_timeout is what we've set above +my $result = $primary->safe_psql( + 'postgres', qq[ + SELECT inactive_timeout = $inactive_timeout + FROM pg_replication_slots WHERE slot_name = 'sb1_slot'; +]); +is($result, "t", + 'check the inactive replication slot info for an active slot'); + +my $logstart = -s $primary->logfile; + +# Stop standby to make the replication slot on primary inactive +$standby1->stop; + +# Wait for the inactive replication slot info to be updated +$primary->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE last_inactive_time IS NOT NULL + AND slot_name = 'sb1_slot' + AND inactive_timeout = $inactive_timeout; +]) + or die + "Timed out while waiting for inactive replication slot info to be updated"; + +check_slots_invalidation_in_server_log($primary, 'sb1_slot', $logstart); + +# Wait for the inactive replication slots to be invalidated. +$primary->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE slot_name = 'sb1_slot' AND + invalidation_reason = 'inactive_timeout'; +]) + or die + "Timed out while waiting for inactive replication slot sb1_slot to be invalidated"; + +# Testcase end: Invalidate streaming standby's slot due to inactive_timeout +# ============================================================================= + +# ============================================================================= +# Testcase start: Invalidate logical subscriber's slot due to inactive_timeout +my $publisher = $primary; + +# Create subscriber node +my $subscriber = PostgreSQL::Test::Cluster->new('sub'); +$subscriber->init; +$subscriber->start; + +# Create tables +$publisher->safe_psql('postgres', "CREATE TABLE test_tbl (id int)"); +$subscriber->safe_psql('postgres', "CREATE TABLE test_tbl (id int)"); + +# Insert some data +$subscriber->safe_psql('postgres', + "INSERT INTO test_tbl VALUES (generate_series(1, 5));"); + +# Setup logical replication +my $publisher_connstr = $publisher->connstr . ' dbname=postgres'; +$publisher->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); +$subscriber->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher_connstr' PUBLICATION pub WITH (slot_name = 'lsub1_slot')" +); + +$subscriber->wait_for_subscription_sync($publisher, 'sub'); + +$result = $subscriber->safe_psql('postgres', "SELECT count(*) FROM test_tbl"); + +is($result, qq(5), "check initial copy was done"); + +# Alter slot to set inactive_timeout +$publisher->safe_psql( + 'postgres', qq[ + SELECT pg_alter_replication_slot(slot_name := 'lsub1_slot', inactive_timeout := $inactive_timeout); +]); + +$logstart = -s $publisher->logfile; + +# Stop subscriber to make the replication slot on publisher inactive +$subscriber->stop; + +# Wait for the inactive replication slot info to be updated +$publisher->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE last_inactive_time IS NOT NULL + AND slot_name = 'lsub1_slot' + AND inactive_timeout = $inactive_timeout; +]) + or die + "Timed out while waiting for inactive replication slot info to be updated"; + +check_slots_invalidation_in_server_log($publisher, 'lsub1_slot', $logstart); + +# Testcase end: Invalidate logical subscriber's slot due to inactive_timeout +# ============================================================================= + +done_testing(); -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 04:18 Amit Kapila <[email protected]> parent: Bharath Rupireddy <[email protected]> 3 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-25 04:18 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Sun, Mar 24, 2024 at 3:05 PM Bharath Rupireddy <[email protected]> wrote: > > On Sun, Mar 24, 2024 at 10:40 AM Amit Kapila <[email protected]> wrote: > > > > > For instance, setting last_inactive_time_1 to an invalid value fails > > > with the following error: > > > > > > error running SQL: 'psql:<stdin>:1: ERROR: invalid input syntax for > > > type timestamp with time zone: "foo" > > > LINE 1: SELECT last_inactive_time > 'foo'::timestamptz FROM pg_repli... > > > > > > > It would be found at a later point. It would be probably better to > > verify immediately after the test that fetches the last_inactive_time > > value. > > Agree. I've added a few more checks explicitly to verify the > last_inactive_time is sane with the following: > > qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) > AND '$last_inactive_time'::timestamptz > > '$slot_creation_time'::timestamptz;] > Such a test looks reasonable but shall we add equal to in the second part of the test (like '$last_inactive_time'::timestamptz >= > '$slot_creation_time'::timestamptz;). This is just to be sure that even if the test ran fast enough to give the same time, the test shouldn't fail. I think it won't matter for correctness as well. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 04:58 Amit Kapila <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-25 04:58 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Mon, Mar 25, 2024 at 9:48 AM Amit Kapila <[email protected]> wrote: > > > Such a test looks reasonable but shall we add equal to in the second > part of the test (like '$last_inactive_time'::timestamptz >= > > '$slot_creation_time'::timestamptz;). This is just to be sure that even if the test ran fast enough to give the same time, the test shouldn't fail. I think it won't matter for correctness as well. > Apart from this, I have made minor changes in the comments. See and let me know what you think of attached. -- With Regards, Amit Kapila. diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 2b36b5fef1..5f4165a945 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2529,8 +2529,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para> <para> The time at which the slot became inactive. - <literal>NULL</literal> if the slot is currently actively being - used. + <literal>NULL</literal> if the slot is currently being used. </para></entry> </row> diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 0f48d6dc7c..77cb633812 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -623,7 +623,7 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); - /* The slot is active by now, so reset the last inactive time. */ + /* Reset the last inactive time as the slot is active now. */ SpinLockAcquire(&s->mutex); s->last_inactive_time = 0; SpinLockRelease(&s->mutex); @@ -687,8 +687,8 @@ ReplicationSlotRelease(void) } /* - * Set the last inactive time after marking slot inactive. We get current - * time beforehand to avoid system call while holding the lock. + * Set the last inactive time after marking the slot inactive. We get the + * current time beforehand to avoid a system call while holding the lock. */ now = GetCurrentTimestamp(); @@ -2363,9 +2363,9 @@ RestoreSlotFromDisk(const char *name) slot->active_pid = 0; /* - * We set last inactive time after loading the slot from the disk into - * memory. Whoever acquires the slot i.e. makes the slot active will - * anyway reset it. + * We set the last inactive time after loading the slot from the disk + * into memory. Whoever acquires the slot i.e. makes the slot active + * will reset it. */ slot->last_inactive_time = GetCurrentTimestamp(); diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 2f18433ecc..eefd7abd39 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -202,7 +202,7 @@ typedef struct ReplicationSlot */ XLogRecPtr last_saved_confirmed_flush; - /* The time at which this slot become inactive */ + /* The time at which this slot becomes inactive */ TimestampTz last_inactive_time; } ReplicationSlot; diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl index bff84cc9c4..81bd36f5d8 100644 --- a/src/test/recovery/t/019_replslot_limit.pl +++ b/src/test/recovery/t/019_replslot_limit.pl @@ -411,7 +411,7 @@ $node_primary3->stop; $node_standby3->stop; # ============================================================================= -# Testcase start: Check last_inactive_time property of streaming standby's slot +# Testcase start: Check last_inactive_time property of the streaming standby's slot # # Initialize primary node @@ -440,8 +440,8 @@ $primary4->safe_psql( SELECT pg_create_physical_replication_slot(slot_name := '$sb4_slot'); ]); -# Get last_inactive_time value after slot's creation. Note that the slot is still -# inactive unless it's used by the standby below. +# Get last_inactive_time value after the slot's creation. Note that the slot +# is still inactive till it's used by the standby below. my $last_inactive_time = $primary4->safe_psql('postgres', qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;) ); @@ -470,8 +470,8 @@ is( $primary4->safe_psql( # Stop the standby to check its last_inactive_time value is updated $standby4->stop; -# Let's also restart the primary so that the last_inactive_time is set upon -# loading the slot from disk. +# Let's restart the primary so that the last_inactive_time is set upon +# loading the slot from the disk. $primary4->restart; is( $primary4->safe_psql( @@ -483,11 +483,11 @@ is( $primary4->safe_psql( $standby4->stop; -# Testcase end: Check last_inactive_time property of streaming standby's slot +# Testcase end: Check last_inactive_time property of the streaming standby's slot # ============================================================================= # ============================================================================= -# Testcase start: Check last_inactive_time property of logical subscriber's slot +# Testcase start: Check last_inactive_time property of the logical subscriber's slot my $publisher4 = $primary4; # Create subscriber node @@ -508,8 +508,8 @@ $publisher4->safe_psql('postgres', "SELECT pg_create_logical_replication_slot(slot_name := '$lsub4_slot', plugin := 'pgoutput');" ); -# Get last_inactive_time value after slot's creation. Note that the slot is still -# inactive unless it's used by the subscriber below. +# Get last_inactive_time value after the slot's creation. Note that the slot +# is still inactive till it's used by the subscriber below. $last_inactive_time = $publisher4->safe_psql('postgres', qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;) ); @@ -541,8 +541,8 @@ is( $publisher4->safe_psql( # Stop the subscriber to check its last_inactive_time value is updated $subscriber4->stop; -# Let's also restart the publisher so that the last_inactive_time is set upon -# loading the slot from disk. +# Let's restart the publisher so that the last_inactive_time is set upon +# loading the slot from the disk. $publisher4->restart; is( $publisher4->safe_psql( @@ -552,7 +552,7 @@ is( $publisher4->safe_psql( 't', 'last inactive time for an inactive logical slot is updated correctly'); -# Testcase end: Check last_inactive_time property of logical subscriber's slot +# Testcase end: Check last_inactive_time property of the logical subscriber's slot # ============================================================================= $publisher4->stop; Attachments: [text/plain] v18_0001_diff_amit.patch.txt (5.8K, ../../CAA4eK1LG+2S7SdJdfbwbPOyKdMU41oZPEaS5OQoo7navT0ER_g@mail.gmail.com/2-v18_0001_diff_amit.patch.txt) download | inline diff: diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 2b36b5fef1..5f4165a945 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2529,8 +2529,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para> <para> The time at which the slot became inactive. - <literal>NULL</literal> if the slot is currently actively being - used. + <literal>NULL</literal> if the slot is currently being used. </para></entry> </row> diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 0f48d6dc7c..77cb633812 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -623,7 +623,7 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); - /* The slot is active by now, so reset the last inactive time. */ + /* Reset the last inactive time as the slot is active now. */ SpinLockAcquire(&s->mutex); s->last_inactive_time = 0; SpinLockRelease(&s->mutex); @@ -687,8 +687,8 @@ ReplicationSlotRelease(void) } /* - * Set the last inactive time after marking slot inactive. We get current - * time beforehand to avoid system call while holding the lock. + * Set the last inactive time after marking the slot inactive. We get the + * current time beforehand to avoid a system call while holding the lock. */ now = GetCurrentTimestamp(); @@ -2363,9 +2363,9 @@ RestoreSlotFromDisk(const char *name) slot->active_pid = 0; /* - * We set last inactive time after loading the slot from the disk into - * memory. Whoever acquires the slot i.e. makes the slot active will - * anyway reset it. + * We set the last inactive time after loading the slot from the disk + * into memory. Whoever acquires the slot i.e. makes the slot active + * will reset it. */ slot->last_inactive_time = GetCurrentTimestamp(); diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 2f18433ecc..eefd7abd39 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -202,7 +202,7 @@ typedef struct ReplicationSlot */ XLogRecPtr last_saved_confirmed_flush; - /* The time at which this slot become inactive */ + /* The time at which this slot becomes inactive */ TimestampTz last_inactive_time; } ReplicationSlot; diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl index bff84cc9c4..81bd36f5d8 100644 --- a/src/test/recovery/t/019_replslot_limit.pl +++ b/src/test/recovery/t/019_replslot_limit.pl @@ -411,7 +411,7 @@ $node_primary3->stop; $node_standby3->stop; # ============================================================================= -# Testcase start: Check last_inactive_time property of streaming standby's slot +# Testcase start: Check last_inactive_time property of the streaming standby's slot # # Initialize primary node @@ -440,8 +440,8 @@ $primary4->safe_psql( SELECT pg_create_physical_replication_slot(slot_name := '$sb4_slot'); ]); -# Get last_inactive_time value after slot's creation. Note that the slot is still -# inactive unless it's used by the standby below. +# Get last_inactive_time value after the slot's creation. Note that the slot +# is still inactive till it's used by the standby below. my $last_inactive_time = $primary4->safe_psql('postgres', qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;) ); @@ -470,8 +470,8 @@ is( $primary4->safe_psql( # Stop the standby to check its last_inactive_time value is updated $standby4->stop; -# Let's also restart the primary so that the last_inactive_time is set upon -# loading the slot from disk. +# Let's restart the primary so that the last_inactive_time is set upon +# loading the slot from the disk. $primary4->restart; is( $primary4->safe_psql( @@ -483,11 +483,11 @@ is( $primary4->safe_psql( $standby4->stop; -# Testcase end: Check last_inactive_time property of streaming standby's slot +# Testcase end: Check last_inactive_time property of the streaming standby's slot # ============================================================================= # ============================================================================= -# Testcase start: Check last_inactive_time property of logical subscriber's slot +# Testcase start: Check last_inactive_time property of the logical subscriber's slot my $publisher4 = $primary4; # Create subscriber node @@ -508,8 +508,8 @@ $publisher4->safe_psql('postgres', "SELECT pg_create_logical_replication_slot(slot_name := '$lsub4_slot', plugin := 'pgoutput');" ); -# Get last_inactive_time value after slot's creation. Note that the slot is still -# inactive unless it's used by the subscriber below. +# Get last_inactive_time value after the slot's creation. Note that the slot +# is still inactive till it's used by the subscriber below. $last_inactive_time = $publisher4->safe_psql('postgres', qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;) ); @@ -541,8 +541,8 @@ is( $publisher4->safe_psql( # Stop the subscriber to check its last_inactive_time value is updated $subscriber4->stop; -# Let's also restart the publisher so that the last_inactive_time is set upon -# loading the slot from disk. +# Let's restart the publisher so that the last_inactive_time is set upon +# loading the slot from the disk. $publisher4->restart; is( $publisher4->safe_psql( @@ -552,7 +552,7 @@ is( $publisher4->safe_psql( 't', 'last inactive time for an inactive logical slot is updated correctly'); -# Testcase end: Check last_inactive_time property of logical subscriber's slot +# Testcase end: Check last_inactive_time property of the logical subscriber's slot # ============================================================================= $publisher4->stop; ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 05:03 shveta malik <[email protected]> parent: Bharath Rupireddy <[email protected]> 3 siblings, 1 reply; 43+ messages in thread From: shveta malik @ 2024-03-25 05:03 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]>; shveta malik <[email protected]> On Sun, Mar 24, 2024 at 3:06 PM Bharath Rupireddy <[email protected]> wrote: > > I've attached the v18 patch set here. Thanks for the patches. Please find few comments: patch 001: -------- 1) slot.h: + /* The time at which this slot become inactive */ + TimestampTz last_inactive_time; become -->became --------- patch 002: 2) slotsync.c: ReplicationSlotCreate(remote_slot->name, true, RS_TEMPORARY, remote_slot->two_phase, remote_slot->failover, - true); + true, 0); + slot->data.inactive_timeout = remote_slot->inactive_timeout; Is there a reason we are not passing 'remote_slot->inactive_timeout' to ReplicationSlotCreate() directly? --------- 3) slotfuncs.c pg_create_logical_replication_slot(): + int inactive_timeout = PG_GETARG_INT32(5); Can we mention here that timeout is in seconds either in comment or rename variable to inactive_timeout_secs? Please do this for create_physical_replication_slot(), create_logical_replication_slot(), pg_create_physical_replication_slot() as well. --------- 4) + int inactive_timeout; /* The amount of time in seconds the slot + * is allowed to be inactive. */ } LogicalSlotInfo; Do we need to mention "before getting invalided" like other places (in last patch)? ---------- 5) Same at these two places. "before getting invalided" to be added in the last patch otherwise the info is incompleted. + + /* The amount of time in seconds the slot is allowed to be inactive */ + int inactive_timeout; } ReplicationSlotPersistentData; + * inactive_timeout: The amount of time in seconds the slot is allowed to be + * inactive. */ void ReplicationSlotCreate(const char *name, bool db_specific, Same here. "before getting invalidated" ? -------- Reviewing more.. thanks Shveta ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 06:23 shveta malik <[email protected]> parent: shveta malik <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: shveta malik @ 2024-03-25 06:23 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]>; shveta malik <[email protected]> On Mon, Mar 25, 2024 at 10:33 AM shveta malik <[email protected]> wrote: > > On Sun, Mar 24, 2024 at 3:06 PM Bharath Rupireddy > <[email protected]> wrote: > > > > I've attached the v18 patch set here. > I have a question. Don't we allow creating subscriptions on an existing slot with a non-null 'inactive_timeout' set where 'inactive_timeout' of the slot is retained even after subscription creation? I tried this: =================== --On publisher, create slot with 120sec inactive_timeout: SELECT * FROM pg_create_logical_replication_slot('logical_slot1', 'pgoutput', false, true, true, 120); --On subscriber, create sub using logical_slot1 create subscription mysubnew1_1 connection 'dbname=newdb1 host=localhost user=shveta port=5433' publication mypubnew1_1 WITH (failover = true, create_slot=false, slot_name='logical_slot1'); --Before creating sub, pg_replication_slots output: slot_name | failover | synced | active | temp | conf | lat | inactive_timeout ---------------+----------+--------+--------+------+------+----------------------------------+------------------ logical_slot1 | t | f | f | f | f | 2024-03-25 11:11:55.375736+05:30 | 120 --After creating sub pg_replication_slots output: (inactive_timeout is 0 now): slot_name |failover | synced | active | temp | conf | | lat | inactive_timeout ---------------+---------+--------+--------+------+------+-+-----+------------------ logical_slot1 |t | f | t | f | f | | | 0 =================== In CreateSubscription, we call 'walrcv_alter_slot()' / 'ReplicationSlotAlter()' when create_slot is false. This call ends up setting active_timeout from 120sec to 0. Is it intentional? thanks Shveta ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 06:55 Bharath Rupireddy <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-25 06:55 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Mon, Mar 25, 2024 at 10:28 AM Amit Kapila <[email protected]> wrote: > > On Mon, Mar 25, 2024 at 9:48 AM Amit Kapila <[email protected]> wrote: > > > > > > Such a test looks reasonable but shall we add equal to in the second > > part of the test (like '$last_inactive_time'::timestamptz >= > > > '$slot_creation_time'::timestamptz;). This is just to be sure that even if the test ran fast enough to give the same time, the test shouldn't fail. I think it won't matter for correctness as well. Agree. I added that in v19 patch. I was having that concern in my mind. That's the reason I wasn't capturing current_time something like below for the same worry that current_timestamp might be the same (or nearly the same) as the slot creation time. That's why I ended up capturing current_timestamp in a separate query than clubbing it up with pg_create_physical_replication_slot. SELECT current_timestamp FROM pg_create_physical_replication_slot('foo'); > Apart from this, I have made minor changes in the comments. See and > let me know what you think of attached. LGTM. I've merged the diff into v19 patch. Please find the attached v19 patch. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/octet-stream] v19-0001-Track-last_inactive_time-in-pg_replication_slots.patch (14.4K, ../../CALj2ACWFVTq-VXvgOsZFDP=ce=NXW84RB5q3hUNtnO_kL8mEcw@mail.gmail.com/2-v19-0001-Track-last_inactive_time-in-pg_replication_slots.patch) download | inline diff: From 16a64093fcb3c4747ebc1ac6fe9e3ddfcbeeab63 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Mon, 25 Mar 2024 06:42:19 +0000 Subject: [PATCH v19] Track last_inactive_time in pg_replication_slots. Till now, the time at which the replication slot became inactive is not tracked directly in pg_replication_slots. This commit adds a new property called last_inactive_time for this. It is set to 0 whenever a slot is made active/acquired and set to current timestamp whenever the slot is inactive/released or restored from the disk. The new property will be useful on production servers to debug and analyze inactive replication slots. It will also help to know the lifetime of a replication slot - one can know how long a streaming standby, logical subscriber, or replication slot consumer is down. The new property will be useful to implement inactive timeout based replication slot invalidation in a future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Reviewed-by: Shveta Malik Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/system-views.sgml | 10 ++ src/backend/catalog/system_views.sql | 1 + src/backend/replication/slot.c | 27 ++++ src/backend/replication/slotfuncs.c | 7 +- src/include/catalog/pg_proc.dat | 6 +- src/include/replication/slot.h | 3 + src/test/recovery/t/019_replslot_limit.pl | 148 ++++++++++++++++++++++ src/test/regress/expected/rules.out | 3 +- 8 files changed, 200 insertions(+), 5 deletions(-) diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index b5da476c20..5f4165a945 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2523,6 +2523,16 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>last_inactive_time</structfield> <type>timestamptz</type> + </para> + <para> + The time at which the slot became inactive. + <literal>NULL</literal> if the slot is currently being used. + </para></entry> + </row> + <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>conflicting</structfield> <type>bool</type> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index f69b7f5580..bc70ff193e 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,6 +1023,7 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, + L.last_inactive_time, L.conflicting, L.invalidation_reason, L.failover, diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index cdf0c450c5..77cb633812 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,6 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; + slot->last_inactive_time = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -622,6 +623,11 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); + /* Reset the last inactive time as the slot is active now. */ + SpinLockAcquire(&s->mutex); + s->last_inactive_time = 0; + SpinLockRelease(&s->mutex); + if (am_walsender) { ereport(log_replication_commands ? LOG : DEBUG1, @@ -645,6 +651,7 @@ ReplicationSlotRelease(void) ReplicationSlot *slot = MyReplicationSlot; char *slotname = NULL; /* keep compiler quiet */ bool is_logical = false; /* keep compiler quiet */ + TimestampTz now; Assert(slot != NULL && slot->active_pid != 0); @@ -679,6 +686,12 @@ ReplicationSlotRelease(void) ReplicationSlotsComputeRequiredXmin(false); } + /* + * Set the last inactive time after marking the slot inactive. We get the + * current time beforehand to avoid a system call while holding the lock. + */ + now = GetCurrentTimestamp(); + if (slot->data.persistency == RS_PERSISTENT) { /* @@ -687,9 +700,16 @@ ReplicationSlotRelease(void) */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; + slot->last_inactive_time = now; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } + else + { + SpinLockAcquire(&slot->mutex); + slot->last_inactive_time = now; + SpinLockRelease(&slot->mutex); + } MyReplicationSlot = NULL; @@ -2342,6 +2362,13 @@ RestoreSlotFromDisk(const char *name) slot->in_use = true; slot->active_pid = 0; + /* + * We set the last inactive time after loading the slot from the disk + * into memory. Whoever acquires the slot i.e. makes the slot active + * will reset it. + */ + slot->last_inactive_time = GetCurrentTimestamp(); + restored = true; break; } diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 4232c1e52e..24f5e6d90a 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -239,7 +239,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 18 +#define PG_GET_REPLICATION_SLOTS_COLS 19 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -410,6 +410,11 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); + if (slot_contents.last_inactive_time > 0) + values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_time); + else + nulls[i++] = true; + cause = slot_contents.data.invalidated; if (SlotIsPhysical(&slot_contents)) diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 71c74350a0..0d26e5b422 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11133,9 +11133,9 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 7f25a083ee..eefd7abd39 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -201,6 +201,9 @@ typedef struct ReplicationSlot * forcibly flushed or not. */ XLogRecPtr last_saved_confirmed_flush; + + /* The time at which this slot becomes inactive */ + TimestampTz last_inactive_time; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl index fe00370c3e..413a291b76 100644 --- a/src/test/recovery/t/019_replslot_limit.pl +++ b/src/test/recovery/t/019_replslot_limit.pl @@ -410,4 +410,152 @@ kill 'CONT', $receiverpid; $node_primary3->stop; $node_standby3->stop; +# ============================================================================= +# Testcase start: Check last_inactive_time property of the streaming standby's slot +# + +# Initialize primary node +my $primary4 = PostgreSQL::Test::Cluster->new('primary4'); +$primary4->init(allows_streaming => 'logical'); +$primary4->start; + +# Take backup +$backup_name = 'my_backup4'; +$primary4->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby4 = PostgreSQL::Test::Cluster->new('standby4'); +$standby4->init_from_backup($primary4, $backup_name, has_streaming => 1); + +my $sb4_slot = 'sb4_slot'; +$standby4->append_conf('postgresql.conf', "primary_slot_name = '$sb4_slot'"); + +my $slot_creation_time = $primary4->safe_psql( + 'postgres', qq[ + SELECT current_timestamp; +]); + +$primary4->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := '$sb4_slot'); +]); + +# Get last_inactive_time value after the slot's creation. Note that the slot +# is still inactive till it's used by the standby below. +my $last_inactive_time = $primary4->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;) +); + +# Check that the captured time is sane +is( $primary4->safe_psql( + 'postgres', + qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) AND '$last_inactive_time'::timestamptz >= '$slot_creation_time'::timestamptz;] + ), + 't', + 'last inactive time for an active physical slot is sane'); + +$standby4->start; + +# Wait until standby has replayed enough data +$primary4->wait_for_catchup($standby4); + +# Now the slot is active so last_inactive_time value must be NULL +is( $primary4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$sb4_slot';] + ), + 't', + 'last inactive time for an active physical slot is NULL'); + +# Stop the standby to check its last_inactive_time value is updated +$standby4->stop; + +# Let's restart the primary so that the last_inactive_time is set upon +# loading the slot from the disk. +$primary4->restart; + +is( $primary4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive physical slot is updated correctly'); + +$standby4->stop; + +# Testcase end: Check last_inactive_time property of the streaming standby's slot +# ============================================================================= + +# ============================================================================= +# Testcase start: Check last_inactive_time property of the logical subscriber's slot +my $publisher4 = $primary4; + +# Create subscriber node +my $subscriber4 = PostgreSQL::Test::Cluster->new('subscriber4'); +$subscriber4->init; + +# Setup logical replication +my $publisher4_connstr = $publisher4->connstr . ' dbname=postgres'; +$publisher4->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); + +$slot_creation_time = $publisher4->safe_psql( + 'postgres', qq[ + SELECT current_timestamp; +]); + +my $lsub4_slot = 'lsub4_slot'; +$publisher4->safe_psql('postgres', + "SELECT pg_create_logical_replication_slot(slot_name := '$lsub4_slot', plugin := 'pgoutput');" +); + +# Get last_inactive_time value after the slot's creation. Note that the slot +# is still inactive till it's used by the subscriber below. +$last_inactive_time = $publisher4->safe_psql('postgres', + qq(SELECT last_inactive_time FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;) +); + +# Check that the captured time is sane +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) AND '$last_inactive_time'::timestamptz >= '$slot_creation_time'::timestamptz;] + ), + 't', + 'last inactive time for an active physical slot is sane'); + +$subscriber4->start; +$subscriber4->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher4_connstr' PUBLICATION pub WITH (slot_name = '$lsub4_slot', create_slot = false)" +); + +# Wait until subscriber has caught up +$subscriber4->wait_for_subscription_sync($publisher4, 'sub'); + +# Now the slot is active so last_inactive_time value must be NULL +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub4_slot';] + ), + 't', + 'last inactive time for an active logical slot is NULL'); + +# Stop the subscriber to check its last_inactive_time value is updated +$subscriber4->stop; + +# Let's restart the publisher so that the last_inactive_time is set upon +# loading the slot from the disk. +$publisher4->restart; + +is( $publisher4->safe_psql( + 'postgres', + qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;] + ), + 't', + 'last inactive time for an inactive logical slot is updated correctly'); + +# Testcase end: Check last_inactive_time property of the logical subscriber's slot +# ============================================================================= + +$publisher4->stop; +$subscriber4->stop; + done_testing(); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 18829ea586..dfcbaec387 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,11 +1473,12 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, + l.last_inactive_time, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 07:13 shveta malik <[email protected]> parent: shveta malik <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: shveta malik @ 2024-03-25 07:13 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]>; shveta malik <[email protected]> On Mon, Mar 25, 2024 at 11:53 AM shveta malik <[email protected]> wrote: > > On Mon, Mar 25, 2024 at 10:33 AM shveta malik <[email protected]> wrote: > > > > On Sun, Mar 24, 2024 at 3:06 PM Bharath Rupireddy > > <[email protected]> wrote: > > > > > > I've attached the v18 patch set here. I have one concern, for synced slots on standby, how do we disallow invalidation due to inactive-timeout immediately after promotion? For synced slots, last_inactive_time and inactive_timeout are both set. Let's say I bring down primary for promotion of standby and then promote standby, there are chances that it may end up invalidating synced slots (considering standby is not brought down during promotion and thus inactive_timeout may already be past 'last_inactive_time'). I tried with smaller unit of inactive_timeout: --Shutdown primary to prepare for planned promotion. --On standby, one synced slot with last_inactive_time (lat) as 12:21 slot_name | failover | synced | active | temp | conf | res | lat | inactive_timeout ---------------+----------+--------+--------+------+------+-----+----------------------------------+------------------ logical_slot1 | t | t | f | f | f | | 2024-03-25 12:21:09.020757+05:30 | 60 --wait for some time, now the time is 12:24 postgres=# select now(); now ---------------------------------- 2024-03-25 12:24:17.616716+05:30 -- promote immediately: ./pg_ctl -D ../../standbydb/ promote -w --on promoted standby: postgres=# select pg_is_in_recovery(); pg_is_in_recovery ------------------- f --synced slot is invalidated immediately on promotion. slot_name | failover | synced | active | temp | conf | res | lat | inactive_timeout ---------------+----------+--------+--------+------+------+------------------+----------------------------------+-------- logical_slot1 | t | t | f | f | f | inactive_timeout | 2024-03-25 12:21:09.020757+05:30 | thanks Shveta ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 07:35 Bertrand Drouvot <[email protected]> parent: Bharath Rupireddy <[email protected]> 0 siblings, 0 replies; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-25 07:35 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Mon, Mar 25, 2024 at 12:25:21PM +0530, Bharath Rupireddy wrote: > On Mon, Mar 25, 2024 at 10:28 AM Amit Kapila <[email protected]> wrote: > > > > On Mon, Mar 25, 2024 at 9:48 AM Amit Kapila <[email protected]> wrote: > > > > > > > > > Such a test looks reasonable but shall we add equal to in the second > > > part of the test (like '$last_inactive_time'::timestamptz >= > > > > '$slot_creation_time'::timestamptz;). This is just to be sure that even if the test ran fast enough to give the same time, the test shouldn't fail. I think it won't matter for correctness as well. > > Agree. I added that in v19 patch. I was having that concern in my > mind. That's the reason I wasn't capturing current_time something like > below for the same worry that current_timestamp might be the same (or > nearly the same) as the slot creation time. That's why I ended up > capturing current_timestamp in a separate query than clubbing it up > with pg_create_physical_replication_slot. > > SELECT current_timestamp FROM pg_create_physical_replication_slot('foo'); > > > Apart from this, I have made minor changes in the comments. See and > > let me know what you think of attached. > Thanks! v19-0001 LGTM, just one Nit comment for 019_replslot_limit.pl: The code for "Get last_inactive_time value after the slot's creation" and "Check that the captured time is sane" is somehow duplicated: is it worth creating 2 functions? Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-25 19:54 Nathan Bossart <[email protected]> parent: Bharath Rupireddy <[email protected]> 3 siblings, 1 reply; 43+ messages in thread From: Nathan Bossart @ 2024-03-25 19:54 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; PostgreSQL Hackers <[email protected]> I apologize that I haven't been able to keep up with this thread for a while, but I'm happy to see the continued interest in $SUBJECT. On Sun, Mar 24, 2024 at 03:05:44PM +0530, Bharath Rupireddy wrote: > This commit particularly lets one specify the inactive_timeout for > a slot via SQL functions pg_create_physical_replication_slot and > pg_create_logical_replication_slot. Off-list, Bharath brought to my attention that the current proposal was to set the timeout at the slot level. While I think that is an entirely reasonable thing to support, the main use-case I have in mind for this feature is for an administrator that wants to prevent inactive slots from causing problems (e.g., transaction ID wraparound) on a server or a number of servers. For that use-case, I think a GUC would be much more convenient. Perhaps there could be a default inactive slot timeout GUC that would be used in the absence of a slot-level setting. Thoughts? -- Nathan Bossart Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 04:00 shveta malik <[email protected]> parent: shveta malik <[email protected]> 0 siblings, 1 reply; 43+ messages in thread From: shveta malik @ 2024-03-26 04:00 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]>; shveta malik <[email protected]> On Mon, Mar 25, 2024 at 12:43 PM shveta malik <[email protected]> wrote: > > I have one concern, for synced slots on standby, how do we disallow > invalidation due to inactive-timeout immediately after promotion? > > For synced slots, last_inactive_time and inactive_timeout are both > set. Let's say I bring down primary for promotion of standby and then > promote standby, there are chances that it may end up invalidating > synced slots (considering standby is not brought down during promotion > and thus inactive_timeout may already be past 'last_inactive_time'). > On standby, if we decide to maintain valid last_inactive_time for synced slots, then invalidation is correctly restricted in InvalidateSlotForInactiveTimeout() for synced slots using the check: if (RecoveryInProgress() && slot->data.synced) return false; But immediately after promotion, we can not rely on the above check and thus possibility of synced slots invalidation is there. To maintain consistent behavior regarding the setting of last_inactive_time for synced slots, similar to user slots, one potential solution to prevent this invalidation issue is to update the last_inactive_time of all synced slots within the ShutDownSlotSync() function during FinishWalRecovery(). This approach ensures that promotion doesn't immediately invalidate slots, and henceforth, we possess a correct last_inactive_time as a basis for invalidation going forward. This will be equivalent to updating last_inactive_time during restart (but without actual restart during promotion). The plus point of maintaining last_inactive_time for synced slots could be, this can provide data to the user on when last time the sync was attempted on that particular slot by background slot sync worker or SQl function. Thoughts? thanks Shveta ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 04:43 Amit Kapila <[email protected]> parent: Nathan Bossart <[email protected]> 0 siblings, 0 replies; 43+ messages in thread From: Amit Kapila @ 2024-03-26 04:43 UTC (permalink / raw) To: Nathan Bossart <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Bertrand Drouvot <[email protected]>; PostgreSQL Hackers <[email protected]> On Tue, Mar 26, 2024 at 1:24 AM Nathan Bossart <[email protected]> wrote: > > > On Sun, Mar 24, 2024 at 03:05:44PM +0530, Bharath Rupireddy wrote: > > This commit particularly lets one specify the inactive_timeout for > > a slot via SQL functions pg_create_physical_replication_slot and > > pg_create_logical_replication_slot. > > Off-list, Bharath brought to my attention that the current proposal was to > set the timeout at the slot level. While I think that is an entirely > reasonable thing to support, the main use-case I have in mind for this > feature is for an administrator that wants to prevent inactive slots from > causing problems (e.g., transaction ID wraparound) on a server or a number > of servers. For that use-case, I think a GUC would be much more > convenient. Perhaps there could be a default inactive slot timeout GUC > that would be used in the absence of a slot-level setting. Thoughts? > Yeah, that is a valid point. One of the reasons for keeping it at slot level was to allow different subscribers/output plugins to have a different setting for invalid_timeout for their respective slots based on their usage. Now, having it as a GUC also has some valid use cases as pointed out by you but I am not sure having both at slot level and at GUC level is required. I was a bit inclined to have it at slot level for now and then based on some field usage report we can later add GUC as well. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 05:37 Bharath Rupireddy <[email protected]> parent: shveta malik <[email protected]> 0 siblings, 2 replies; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-26 05:37 UTC (permalink / raw) To: shveta malik <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Tue, Mar 26, 2024 at 9:30 AM shveta malik <[email protected]> wrote: > > On Mon, Mar 25, 2024 at 12:43 PM shveta malik <[email protected]> wrote: > > > > I have one concern, for synced slots on standby, how do we disallow > > invalidation due to inactive-timeout immediately after promotion? > > > > For synced slots, last_inactive_time and inactive_timeout are both > > set. Let's say I bring down primary for promotion of standby and then > > promote standby, there are chances that it may end up invalidating > > synced slots (considering standby is not brought down during promotion > > and thus inactive_timeout may already be past 'last_inactive_time'). > > > > On standby, if we decide to maintain valid last_inactive_time for > synced slots, then invalidation is correctly restricted in > InvalidateSlotForInactiveTimeout() for synced slots using the check: > > if (RecoveryInProgress() && slot->data.synced) > return false; > > But immediately after promotion, we can not rely on the above check > and thus possibility of synced slots invalidation is there. To > maintain consistent behavior regarding the setting of > last_inactive_time for synced slots, similar to user slots, one > potential solution to prevent this invalidation issue is to update the > last_inactive_time of all synced slots within the ShutDownSlotSync() > function during FinishWalRecovery(). This approach ensures that > promotion doesn't immediately invalidate slots, and henceforth, we > possess a correct last_inactive_time as a basis for invalidation going > forward. This will be equivalent to updating last_inactive_time during > restart (but without actual restart during promotion). > The plus point of maintaining last_inactive_time for synced slots > could be, this can provide data to the user on when last time the sync > was attempted on that particular slot by background slot sync worker > or SQl function. Thoughts? Please find the attached v21 patch implementing the above idea. It also has changes for renaming last_inactive_time to inactive_since. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/octet-stream] v21-0001-Fix-review-comments-for-slot-s-last_inactive_tim.patch (21.2K, ../../CALj2ACXRFx9g7A9RFJZF7eBe=zxk7=apMRFuCgJJKYB7O=vgwg@mail.gmail.com/2-v21-0001-Fix-review-comments-for-slot-s-last_inactive_tim.patch) download | inline diff: From fc9e61195b19768eacc856f72c185323483d2187 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Tue, 26 Mar 2024 05:33:39 +0000 Subject: [PATCH v21] Fix review comments for slot's last_inactive_time property This commit addresses review comments received for the slot's last_inactive_time property added by commit a11f330b55. It does the following: 1. Name last_inactive_time seems confusing. With that, one expects it to tell the last time that the slot was inactive. But, it tells the last time that a currently-inactive slot previously *WAS* active. This commit uses a less confusing name inactive_since for the property. Other names considered were released_time, deactivated_at but inactive_since won the race since the word inactive is predominant as far as the replication slots are concerned. 2. The slot's last_inactive_time isn't currently maintained for synced slots on the standby. The commit a11f330b55 prevents updating last_inactive_time with RecoveryInProgress() check in RestoreSlotFromDisk(). But, the issue is that RecoveryInProgress() always returns true in RestoreSlotFromDisk() as 'xlogctl->SharedRecoveryState' is always 'RECOVERY_STATE_CRASH' at that time. The impact of this on a promoted standby last_inactive_at is always NULL for all synced slots even after server restart. Above issue led us to a question as to why we can't maintain last_inactive_time for synced slots on the standby. There's a use-case for having it that as it can tell the last synced time on the standby apart from fixing the above issue. So, this commit does two things a) maintains last_inactive_time for such slots, b) ensures the value is set to current timestamp during the shutdown to help correctly interpret the time if the standby gets promoted without a restart. Reported-by: Robert Haas, Shveta Malik Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila, Shveta Malik Discussion: https://www.postgresql.org/message-id/ZgGrCBQoktdLi1Ir%40ip-10-97-1-34.eu-west-3.compute.internal Discussion: https://www.postgresql.org/message-id/ZgGrCBQoktdLi1Ir%40ip-10-97-1-34.eu-west-3.compute.internal Discussion: https://www.postgresql.org/message-id/CAJpy0uB-yE%2BRiw7JQ4hW0%2BigJxvPc%2Brq%2B9c7WyTa1Jz7%2B2gAiA%40mail.gmail.com --- doc/src/sgml/system-views.sgml | 4 +- src/backend/catalog/system_views.sql | 2 +- src/backend/replication/logical/slotsync.c | 43 +++++++++++++ src/backend/replication/slot.c | 38 +++++------- src/backend/replication/slotfuncs.c | 4 +- src/include/catalog/pg_proc.dat | 2 +- src/include/replication/slot.h | 4 +- src/test/recovery/t/019_replslot_limit.pl | 62 +++++++++---------- .../t/040_standby_failover_slots_sync.pl | 34 ++++++++++ src/test/regress/expected/rules.out | 4 +- 10 files changed, 135 insertions(+), 62 deletions(-) diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 5f4165a945..19a08ca0ac 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2525,10 +2525,10 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <row> <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>last_inactive_time</structfield> <type>timestamptz</type> + <structfield>inactive_since</structfield> <type>timestamptz</type> </para> <para> - The time at which the slot became inactive. + The time since the slot has became inactive. <literal>NULL</literal> if the slot is currently being used. </para></entry> </row> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index bc70ff193e..401fb35947 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,7 +1023,7 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, - L.last_inactive_time, + L.inactive_since, L.conflicting, L.invalidation_reason, L.failover, diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index 30480960c5..cfb5affeaa 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -140,6 +140,7 @@ typedef struct RemoteSlot } RemoteSlot; static void slotsync_failure_callback(int code, Datum arg); +static void reset_synced_slots_info(void); /* * If necessary, update the local synced slot's metadata based on the data @@ -1296,6 +1297,45 @@ ReplSlotSyncWorkerMain(char *startup_data, size_t startup_data_len) Assert(false); } +/* + * Reset the synced slots info such as inactive_since after shutting + * down the slot sync machinery. + */ +static void +reset_synced_slots_info(void) +{ + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + for (int i = 0; i < max_replication_slots; i++) + { + ReplicationSlot *s = &ReplicationSlotCtl->replication_slots[i]; + + /* Check if it is a synchronized slot */ + if (s->in_use && s->data.synced) + { + TimestampTz now; + + Assert(SlotIsLogical(s)); + Assert(s->active_pid == 0); + + /* + * Set the time since the slot has became inactive after shutting + * down slot sync machinery. This helps correctly interpret the + * time if the standby gets promoted without a restart. We get the + * current time beforehand to avoid a system call while holding + * the lock. + */ + now = GetCurrentTimestamp(); + + SpinLockAcquire(&s->mutex); + s->inactive_since = now; + SpinLockRelease(&s->mutex); + } + } + + LWLockRelease(ReplicationSlotControlLock); +} + /* * Shut down the slot sync worker. */ @@ -1309,6 +1349,7 @@ ShutDownSlotSync(void) if (SlotSyncCtx->pid == InvalidPid) { SpinLockRelease(&SlotSyncCtx->mutex); + reset_synced_slots_info(); return; } SpinLockRelease(&SlotSyncCtx->mutex); @@ -1341,6 +1382,8 @@ ShutDownSlotSync(void) } SpinLockRelease(&SlotSyncCtx->mutex); + + reset_synced_slots_info(); } /* diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 45f7a28f7d..860c7fbeb0 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,7 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; - slot->last_inactive_time = 0; + slot->inactive_since = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -623,9 +623,12 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); - /* Reset the last inactive time as the slot is active now. */ + /* + * Reset the time since the slot has became inactive as the slot is active + * now. + */ SpinLockAcquire(&s->mutex); - s->last_inactive_time = 0; + s->inactive_since = 0; SpinLockRelease(&s->mutex); if (am_walsender) @@ -651,7 +654,7 @@ ReplicationSlotRelease(void) ReplicationSlot *slot = MyReplicationSlot; char *slotname = NULL; /* keep compiler quiet */ bool is_logical = false; /* keep compiler quiet */ - TimestampTz now = 0; + TimestampTz now; Assert(slot != NULL && slot->active_pid != 0); @@ -687,13 +690,11 @@ ReplicationSlotRelease(void) } /* - * Set the last inactive time after marking the slot inactive. We don't - * set it for the slots currently being synced from the primary to the - * standby because such slots are typically inactive as decoding is not - * allowed on those. + * Set the time since the slot has became inactive after marking it + * inactive. We get the current time beforehand to avoid a system call + * while holding the lock. */ - if (!(RecoveryInProgress() && slot->data.synced)) - now = GetCurrentTimestamp(); + now = GetCurrentTimestamp(); if (slot->data.persistency == RS_PERSISTENT) { @@ -703,14 +704,14 @@ ReplicationSlotRelease(void) */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; - slot->last_inactive_time = now; + slot->inactive_since = now; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } else { SpinLockAcquire(&slot->mutex); - slot->last_inactive_time = now; + slot->inactive_since = now; SpinLockRelease(&slot->mutex); } @@ -2366,16 +2367,11 @@ RestoreSlotFromDisk(const char *name) slot->active_pid = 0; /* - * We set the last inactive time after loading the slot from the disk - * into memory. Whoever acquires the slot i.e. makes the slot active - * will reset it. We don't set it for the slots currently being synced - * from the primary to the standby because such slots are typically - * inactive as decoding is not allowed on those. + * We set the time since the slot has became inactive after loading + * the slot from the disk into memory. Whoever acquires the slot i.e. + * makes the slot active will reset it. */ - if (!(RecoveryInProgress() && slot->data.synced)) - slot->last_inactive_time = GetCurrentTimestamp(); - else - slot->last_inactive_time = 0; + slot->inactive_since = GetCurrentTimestamp(); restored = true; break; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 24f5e6d90a..da57177c25 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -410,8 +410,8 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); - if (slot_contents.last_inactive_time > 0) - values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_time); + if (slot_contents.inactive_since > 0) + values[i++] = TimestampTzGetDatum(slot_contents.inactive_since); else nulls[i++] = true; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 0d26e5b422..2f7cfc02c6 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11135,7 +11135,7 @@ proargtypes => '', proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,conflicting,invalidation_reason,failover,synced}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,inactive_since,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index eefd7abd39..d032ce8d28 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -202,8 +202,8 @@ typedef struct ReplicationSlot */ XLogRecPtr last_saved_confirmed_flush; - /* The time at which this slot becomes inactive */ - TimestampTz last_inactive_time; + /* The time since the slot has became inactive */ + TimestampTz inactive_since; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl index 3409cf88cd..3b9a306a8b 100644 --- a/src/test/recovery/t/019_replslot_limit.pl +++ b/src/test/recovery/t/019_replslot_limit.pl @@ -411,7 +411,7 @@ $node_primary3->stop; $node_standby3->stop; # ============================================================================= -# Testcase start: Check last_inactive_time property of the streaming standby's slot +# Testcase start: Check inactive_since property of the streaming standby's slot # # Initialize primary node @@ -440,45 +440,45 @@ $primary4->safe_psql( SELECT pg_create_physical_replication_slot(slot_name := '$sb4_slot'); ]); -# Get last_inactive_time value after the slot's creation. Note that the slot -# is still inactive till it's used by the standby below. -my $last_inactive_time = - capture_and_validate_slot_last_inactive_time($primary4, $sb4_slot, $slot_creation_time); +# Get inactive_since value after the slot's creation. Note that the slot is +# still inactive till it's used by the standby below. +my $inactive_since = + capture_and_validate_slot_inactive_since($primary4, $sb4_slot, $slot_creation_time); $standby4->start; # Wait until standby has replayed enough data $primary4->wait_for_catchup($standby4); -# Now the slot is active so last_inactive_time value must be NULL +# Now the slot is active so inactive_since value must be NULL is( $primary4->safe_psql( 'postgres', - qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$sb4_slot';] + qq[SELECT inactive_since IS NULL FROM pg_replication_slots WHERE slot_name = '$sb4_slot';] ), 't', 'last inactive time for an active physical slot is NULL'); -# Stop the standby to check its last_inactive_time value is updated +# Stop the standby to check its inactive_since value is updated $standby4->stop; -# Let's restart the primary so that the last_inactive_time is set upon -# loading the slot from the disk. +# Let's restart the primary so that the inactive_since is set upon loading the +# slot from the disk. $primary4->restart; is( $primary4->safe_psql( 'postgres', - qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;] + qq[SELECT inactive_since > '$inactive_since'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND inactive_since IS NOT NULL;] ), 't', 'last inactive time for an inactive physical slot is updated correctly'); $standby4->stop; -# Testcase end: Check last_inactive_time property of the streaming standby's slot +# Testcase end: Check inactive_since property of the streaming standby's slot # ============================================================================= # ============================================================================= -# Testcase start: Check last_inactive_time property of the logical subscriber's slot +# Testcase start: Check inactive_since property of the logical subscriber's slot my $publisher4 = $primary4; # Create subscriber node @@ -499,10 +499,10 @@ $publisher4->safe_psql('postgres', "SELECT pg_create_logical_replication_slot(slot_name := '$lsub4_slot', plugin := 'pgoutput');" ); -# Get last_inactive_time value after the slot's creation. Note that the slot -# is still inactive till it's used by the subscriber below. -$last_inactive_time = - capture_and_validate_slot_last_inactive_time($publisher4, $lsub4_slot, $slot_creation_time); +# Get inactive_since value after the slot's creation. Note that the slot is +# still inactive till it's used by the subscriber below. +$inactive_since = + capture_and_validate_slot_inactive_since($publisher4, $lsub4_slot, $slot_creation_time); $subscriber4->start; $subscriber4->safe_psql('postgres', @@ -512,54 +512,54 @@ $subscriber4->safe_psql('postgres', # Wait until subscriber has caught up $subscriber4->wait_for_subscription_sync($publisher4, 'sub'); -# Now the slot is active so last_inactive_time value must be NULL +# Now the slot is active so inactive_since value must be NULL is( $publisher4->safe_psql( 'postgres', - qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub4_slot';] + qq[SELECT inactive_since IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub4_slot';] ), 't', 'last inactive time for an active logical slot is NULL'); -# Stop the subscriber to check its last_inactive_time value is updated +# Stop the subscriber to check its inactive_since value is updated $subscriber4->stop; -# Let's restart the publisher so that the last_inactive_time is set upon +# Let's restart the publisher so that the inactive_since is set upon # loading the slot from the disk. $publisher4->restart; is( $publisher4->safe_psql( 'postgres', - qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;] + qq[SELECT inactive_since > '$inactive_since'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND inactive_since IS NOT NULL;] ), 't', 'last inactive time for an inactive logical slot is updated correctly'); -# Testcase end: Check last_inactive_time property of the logical subscriber's slot +# Testcase end: Check inactive_since property of the logical subscriber's slot # ============================================================================= $publisher4->stop; $subscriber4->stop; -# Capture and validate last_inactive_time of a given slot. -sub capture_and_validate_slot_last_inactive_time +# Capture and validate inactive_since of a given slot. +sub capture_and_validate_slot_inactive_since { my ($node, $slot_name, $slot_creation_time) = @_; - my $last_inactive_time = $node->safe_psql('postgres', - qq(SELECT last_inactive_time FROM pg_replication_slots - WHERE slot_name = '$slot_name' AND last_inactive_time IS NOT NULL;) + my $inactive_since = $node->safe_psql('postgres', + qq(SELECT inactive_since FROM pg_replication_slots + WHERE slot_name = '$slot_name' AND inactive_since IS NOT NULL;) ); # Check that the captured time is sane is( $node->safe_psql( 'postgres', - qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) AND - '$last_inactive_time'::timestamptz >= '$slot_creation_time'::timestamptz;] + qq[SELECT '$inactive_since'::timestamptz > to_timestamp(0) AND + '$inactive_since'::timestamptz >= '$slot_creation_time'::timestamptz;] ), 't', "last inactive time for an active slot $slot_name is sane"); - return $last_inactive_time; + return $inactive_since; } done_testing(); diff --git a/src/test/recovery/t/040_standby_failover_slots_sync.pl b/src/test/recovery/t/040_standby_failover_slots_sync.pl index f47bfd78eb..e64308cbf1 100644 --- a/src/test/recovery/t/040_standby_failover_slots_sync.pl +++ b/src/test/recovery/t/040_standby_failover_slots_sync.pl @@ -178,6 +178,13 @@ $primary->poll_query_until( # the subscriber. $primary->wait_for_replay_catchup($standby1); +# Capture the time before which the logical failover slots are synced/created +# on the standby. +my $slots_creation_time = $standby1->safe_psql( + 'postgres', qq[ + SELECT current_timestamp; +]); + # Synchronize the primary server slots to the standby. $standby1->safe_psql('postgres', "SELECT pg_sync_replication_slots();"); @@ -190,6 +197,11 @@ is( $standby1->safe_psql( "t", 'logical slots have synced as true on standby'); +# Confirm that the logical failover slots that have synced on the standby has +# got a valid inactive_since value representing the last slot sync time. +capture_and_validate_slot_inactive_since($standby1, 'lsub1_slot', $slots_creation_time); +capture_and_validate_slot_inactive_since($standby1, 'lsub2_slot', $slots_creation_time); + ################################################## # Test that the synchronized slot will be dropped if the corresponding remote # slot on the primary server has been dropped. @@ -773,4 +785,26 @@ is( $subscriber1->safe_psql('postgres', q{SELECT count(*) FROM tab_int;}), "20", 'data replicated from the new primary'); +# Capture and validate inactive_since of a given slot. +sub capture_and_validate_slot_inactive_since +{ + my ($node, $slot_name, $slot_creation_time) = @_; + + my $inactive_since = $node->safe_psql('postgres', + qq(SELECT inactive_since FROM pg_replication_slots + WHERE slot_name = '$slot_name' AND inactive_since IS NOT NULL;) + ); + + # Check that the captured time is sane + is( $node->safe_psql( + 'postgres', + qq[SELECT '$inactive_since'::timestamptz > to_timestamp(0) AND + '$inactive_since'::timestamptz >= '$slot_creation_time'::timestamptz;] + ), + 't', + "last inactive time for a synced slot $slot_name is sane"); + + return $inactive_since; +} + done_testing(); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index dfcbaec387..f53c3036a6 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,12 +1473,12 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, - l.last_inactive_time, + l.inactive_since, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, inactive_since, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 05:56 Amit Kapila <[email protected]> parent: Bharath Rupireddy <[email protected]> 3 siblings, 1 reply; 43+ messages in thread From: Amit Kapila @ 2024-03-26 05:56 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Sun, Mar 24, 2024 at 3:05 PM Bharath Rupireddy <[email protected]> wrote: > > I've attached the v18 patch set here. I've also addressed earlier > review comments from Amit, Ajin Cherian. Note that I've added new > invalidation mechanism tests in a separate TAP test file just because > I don't want to clutter or bloat any of the existing files and spread > tests for physical slots and logical slots into separate existing TAP > files. > Review comments on v18_0002 and v18_0005 ======================================= 1. ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, - bool two_phase, bool failover, bool synced) + bool two_phase, bool failover, bool synced, + int inactive_timeout) { ReplicationSlot *slot = NULL; int i; @@ -345,6 +348,18 @@ ReplicationSlotCreate(const char *name, bool db_specific, errmsg("cannot enable failover for a temporary replication slot")); } + if (inactive_timeout > 0) + { + /* + * Do not allow users to set inactive_timeout for temporary slots, + * because temporary slots will not be saved to the disk. + */ + if (persistency == RS_TEMPORARY) + ereport(ERROR, + errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("cannot set inactive_timeout for a temporary replication slot")); + } We have decided to update inactive_since for temporary slots. So, unless there is some reason, we should allow inactive_timeout to also be set for temporary slots. 2. --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1024,6 +1024,7 @@ CREATE VIEW pg_replication_slots AS L.safe_wal_size, L.two_phase, L.last_inactive_time, + L.inactive_timeout, Shall we keep inactive_timeout before last_inactive_time/inactive_since? I don't have any strong reason to propose that way apart from that the former is provided by the user. 3. @@ -287,6 +288,13 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) slot_contents = *slot; SpinLockRelease(&slot->mutex); + /* + * Here's an opportunity to invalidate inactive replication slots + * based on timeout, so let's do it. + */ + if (InvalidateReplicationSlotForInactiveTimeout(slot, false, true, true)) + invalidated = true; I don't think we should try to invalidate the slots in pg_get_replication_slots. This function's purpose is to get the current information on slots and has no intention to perform any work for slots. Any error due to invalidation won't be what the user would be expecting here. 4. +static bool +InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_control_lock, + bool need_mutex) { ... ... + if (need_control_lock) + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); + + /* + * Check if the slot needs to be invalidated due to inactive_timeout. We + * do this with the spinlock held to avoid race conditions -- for example + * the restart_lsn could move forward, or the slot could be dropped. + */ + if (need_mutex) + SpinLockAcquire(&slot->mutex); ... I find this combination of parameters a bit strange. Because, say if need_mutex is false and need_control_lock is true then that means this function will acquire LWlock after acquiring spinlock which is unacceptable. Now, this may not happen in practice as the callers won't pass such a combination but still, this functionality should be improved. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 06:34 shveta malik <[email protected]> parent: Bharath Rupireddy <[email protected]> 1 sibling, 0 replies; 43+ messages in thread From: shveta malik @ 2024-03-26 06:34 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]>; shveta malik <[email protected]> On Tue, Mar 26, 2024 at 11:08 AM Bharath Rupireddy <[email protected]> wrote: > > On Tue, Mar 26, 2024 at 9:30 AM shveta malik <[email protected]> wrote: > > > > On Mon, Mar 25, 2024 at 12:43 PM shveta malik <[email protected]> wrote: > > > > > > I have one concern, for synced slots on standby, how do we disallow > > > invalidation due to inactive-timeout immediately after promotion? > > > > > > For synced slots, last_inactive_time and inactive_timeout are both > > > set. Let's say I bring down primary for promotion of standby and then > > > promote standby, there are chances that it may end up invalidating > > > synced slots (considering standby is not brought down during promotion > > > and thus inactive_timeout may already be past 'last_inactive_time'). > > > > > > > On standby, if we decide to maintain valid last_inactive_time for > > synced slots, then invalidation is correctly restricted in > > InvalidateSlotForInactiveTimeout() for synced slots using the check: > > > > if (RecoveryInProgress() && slot->data.synced) > > return false; > > > > But immediately after promotion, we can not rely on the above check > > and thus possibility of synced slots invalidation is there. To > > maintain consistent behavior regarding the setting of > > last_inactive_time for synced slots, similar to user slots, one > > potential solution to prevent this invalidation issue is to update the > > last_inactive_time of all synced slots within the ShutDownSlotSync() > > function during FinishWalRecovery(). This approach ensures that > > promotion doesn't immediately invalidate slots, and henceforth, we > > possess a correct last_inactive_time as a basis for invalidation going > > forward. This will be equivalent to updating last_inactive_time during > > restart (but without actual restart during promotion). > > The plus point of maintaining last_inactive_time for synced slots > > could be, this can provide data to the user on when last time the sync > > was attempted on that particular slot by background slot sync worker > > or SQl function. Thoughts? > > Please find the attached v21 patch implementing the above idea. It > also has changes for renaming last_inactive_time to inactive_since. > Thanks for the patch. I have tested this patch alone, and it does what it says. One additional thing which I noticed is that now it sets inactive_since for temp slots as well, but that idea looks fine to me. I could not test 'invalidation on promotion bug' with this change, as that needed rebasing of the rest of the patches. Few trivial things: 1) Commti msg: ensures the value is set to current timestamp during the shutdown to help correctly interpret the time if the standby gets promoted without a restart. shutdown --> shutdown of slot sync worker (as it was not clear if it is instance shutdown or something else) 2) 'The time since the slot has became inactive'. has became-->has become or just became Please check it in all the files. There are multiple places. thanks Shveta ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 07:45 Bertrand Drouvot <[email protected]> parent: Bharath Rupireddy <[email protected]> 1 sibling, 0 replies; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-26 07:45 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: shveta malik <[email protected]>; Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Tue, Mar 26, 2024 at 11:07:51AM +0530, Bharath Rupireddy wrote: > On Tue, Mar 26, 2024 at 9:30 AM shveta malik <[email protected]> wrote: > > But immediately after promotion, we can not rely on the above check > > and thus possibility of synced slots invalidation is there. To > > maintain consistent behavior regarding the setting of > > last_inactive_time for synced slots, similar to user slots, one > > potential solution to prevent this invalidation issue is to update the > > last_inactive_time of all synced slots within the ShutDownSlotSync() > > function during FinishWalRecovery(). This approach ensures that > > promotion doesn't immediately invalidate slots, and henceforth, we > > possess a correct last_inactive_time as a basis for invalidation going > > forward. This will be equivalent to updating last_inactive_time during > > restart (but without actual restart during promotion). > > The plus point of maintaining last_inactive_time for synced slots > > could be, this can provide data to the user on when last time the sync > > was attempted on that particular slot by background slot sync worker > > or SQl function. Thoughts? > > Please find the attached v21 patch implementing the above idea. It > also has changes for renaming last_inactive_time to inactive_since. Thanks! A few comments: 1 === One trailing whitespace: Applying: Fix review comments for slot's last_inactive_time property .git/rebase-apply/patch:433: trailing whitespace. # got a valid inactive_since value representing the last slot sync time. warning: 1 line adds whitespace errors. 2 === It looks like inactive_since is set to the current timestamp on the standby each time the sync worker does a cycle: primary: postgres=# select slot_name,inactive_since from pg_replication_slots where failover = 't'; slot_name | inactive_since -------------+------------------------------- lsub27_slot | 2024-03-26 07:39:19.745517+00 lsub28_slot | 2024-03-26 07:40:24.953826+00 standby: postgres=# select slot_name,inactive_since from pg_replication_slots where failover = 't'; slot_name | inactive_since -------------+------------------------------- lsub27_slot | 2024-03-26 07:43:56.387324+00 lsub28_slot | 2024-03-26 07:43:56.387338+00 I don't think that should be the case. Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 08:57 Bharath Rupireddy <[email protected]> parent: Amit Kapila <[email protected]> 0 siblings, 3 replies; 43+ messages in thread From: Bharath Rupireddy @ 2024-03-26 08:57 UTC (permalink / raw) To: Amit Kapila <[email protected]>; +Cc: Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Tue, Mar 26, 2024 at 11:26 AM Amit Kapila <[email protected]> wrote: > > Review comments on v18_0002 and v18_0005 > ======================================= > > 1. > We have decided to update inactive_since for temporary slots. So, > unless there is some reason, we should allow inactive_timeout to also > be set for temporary slots. WFM. A temporary slot that's inactive for a long time before even the server isn't shutdown can utilize this inactive_timeout based invalidation mechanism. And, I'd also vote for we being consistent for temporary and synced slots. > L.last_inactive_time, > + L.inactive_timeout, > > Shall we keep inactive_timeout before > last_inactive_time/inactive_since? I don't have any strong reason to > propose that way apart from that the former is provided by the user. Done. > + if (InvalidateReplicationSlotForInactiveTimeout(slot, false, true, true)) > + invalidated = true; > > I don't think we should try to invalidate the slots in > pg_get_replication_slots. This function's purpose is to get the > current information on slots and has no intention to perform any work > for slots. Any error due to invalidation won't be what the user would > be expecting here. Agree. Removed. > 4. > +static bool > +InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, > + bool need_control_lock, > + bool need_mutex) > { > ... > ... > + if (need_control_lock) > + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); > + > + Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); > + > + /* > + * Check if the slot needs to be invalidated due to inactive_timeout. We > + * do this with the spinlock held to avoid race conditions -- for example > + * the restart_lsn could move forward, or the slot could be dropped. > + */ > + if (need_mutex) > + SpinLockAcquire(&slot->mutex); > ... > > I find this combination of parameters a bit strange. Because, say if > need_mutex is false and need_control_lock is true then that means this > function will acquire LWlock after acquiring spinlock which is > unacceptable. Now, this may not happen in practice as the callers > won't pass such a combination but still, this functionality should be > improved. Right. Either we need two locks or not. So, changed it to use just one bool need_locks, upon set both control lock and spin lock are acquired and released. On Mon, Mar 25, 2024 at 10:33 AM shveta malik <[email protected]> wrote: > > patch 002: > > 2) > slotsync.c: > > ReplicationSlotCreate(remote_slot->name, true, RS_TEMPORARY, > remote_slot->two_phase, > remote_slot->failover, > - true); > + true, 0); > > + slot->data.inactive_timeout = remote_slot->inactive_timeout; > > Is there a reason we are not passing 'remote_slot->inactive_timeout' > to ReplicationSlotCreate() directly? The slot there gets created temporarily for which we were not supporting inactive_timeout being set. But, in the latest v22 patch we are supporting, so passing the remote_slot->inactive_timeout directly. > 3) > slotfuncs.c > pg_create_logical_replication_slot(): > + int inactive_timeout = PG_GETARG_INT32(5); > > Can we mention here that timeout is in seconds either in comment or > rename variable to inactive_timeout_secs? > > Please do this for create_physical_replication_slot(), > create_logical_replication_slot(), > pg_create_physical_replication_slot() as well. Added /* in seconds */ next the variable declaration. > --------- > 4) > + int inactive_timeout; /* The amount of time in seconds the slot > + * is allowed to be inactive. */ > } LogicalSlotInfo; > > Do we need to mention "before getting invalided" like other places > (in last patch)? Done. > 5) > Same at these two places. "before getting invalided" to be added in > the last patch otherwise the info is incompleted. > > + > + /* The amount of time in seconds the slot is allowed to be inactive */ > + int inactive_timeout; > } ReplicationSlotPersistentData; > > > + * inactive_timeout: The amount of time in seconds the slot is allowed to be > + * inactive. > */ > void > ReplicationSlotCreate(const char *name, bool db_specific, > Same here. "before getting invalidated" ? Done. On Tue, Mar 26, 2024 at 12:04 PM shveta malik <[email protected]> wrote: > > > Please find the attached v21 patch implementing the above idea. It > > also has changes for renaming last_inactive_time to inactive_since. > > Thanks for the patch. I have tested this patch alone, and it does what > it says. One additional thing which I noticed is that now it sets > inactive_since for temp slots as well, but that idea looks fine to me. Right. Let's be consistent by treating all slots the same. > I could not test 'invalidation on promotion bug' with this change, as > that needed rebasing of the rest of the patches. Please use the v22 patch set. > Few trivial things: > > 1) > Commti msg: > > ensures the value is set to current timestamp during the > shutdown to help correctly interpret the time if the standby gets > promoted without a restart. > > shutdown --> shutdown of slot sync worker (as it was not clear if it > is instance shutdown or something else) Changed it to "shutdown of slot sync machinery" to be consistent with the comments. > 2) > 'The time since the slot has became inactive'. > > has became-->has become > or just became > > Please check it in all the files. There are multiple places. Fixed. Please see the attached v23 patches. I've addressed all the review comments received so far from Amit and Shveta. -- Bharath Rupireddy PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com Attachments: [application/x-patch] v22-0001-Fix-review-comments-for-slot-s-last_inactive_tim.patch (21.2K, ../../CALj2ACW-QtWfyC7cUXJsRe_YO50fNj5pKFY5FA7BC3LJv4XNEw@mail.gmail.com/2-v22-0001-Fix-review-comments-for-slot-s-last_inactive_tim.patch) download | inline diff: From a19a324c057994025f0486f5016dd67ca39b731b Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Tue, 26 Mar 2024 07:56:25 +0000 Subject: [PATCH v22 1/3] Fix review comments for slot's last_inactive_time property This commit addresses review comments received for the slot's last_inactive_time property added by commit a11f330b55. It does the following: 1. Name last_inactive_time seems confusing. With that, one expects it to tell the last time that the slot was inactive. But, it tells the last time that a currently-inactive slot previously *WAS* active. This commit uses a less confusing name inactive_since for the property. Other names considered were released_time, deactivated_at but inactive_since won the race since the word inactive is predominant as far as the replication slots are concerned. 2. The slot's last_inactive_time isn't currently maintained for synced slots on the standby. The commit a11f330b55 prevents updating last_inactive_time with RecoveryInProgress() check in RestoreSlotFromDisk(). But, the issue is that RecoveryInProgress() always returns true in RestoreSlotFromDisk() as 'xlogctl->SharedRecoveryState' is always 'RECOVERY_STATE_CRASH' at that time. The impact of this on a promoted standby last_inactive_at is always NULL for all synced slots even after server restart. Above issue led us to a question as to why we can't maintain last_inactive_time for synced slots on the standby. There's a use-case for having it that as it can tell the last synced time on the standby apart from fixing the above issue. So, this commit does two things a) maintains last_inactive_time for such slots, b) ensures the value is set to current timestamp during the shutdown of slot sync machinery to help correctly interpret the time if the standby gets promoted without a restart. Reported-by: Robert Haas, Shveta Malik Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila, Shveta Malik Discussion: https://www.postgresql.org/message-id/ZgGrCBQoktdLi1Ir%40ip-10-97-1-34.eu-west-3.compute.internal Discussion: https://www.postgresql.org/message-id/ZgGrCBQoktdLi1Ir%40ip-10-97-1-34.eu-west-3.compute.internal Discussion: https://www.postgresql.org/message-id/CAJpy0uB-yE%2BRiw7JQ4hW0%2BigJxvPc%2Brq%2B9c7WyTa1Jz7%2B2gAiA%40mail.gmail.com --- doc/src/sgml/system-views.sgml | 4 +- src/backend/catalog/system_views.sql | 2 +- src/backend/replication/logical/slotsync.c | 43 +++++++++++++ src/backend/replication/slot.c | 38 +++++------- src/backend/replication/slotfuncs.c | 4 +- src/include/catalog/pg_proc.dat | 2 +- src/include/replication/slot.h | 4 +- src/test/recovery/t/019_replslot_limit.pl | 62 +++++++++---------- .../t/040_standby_failover_slots_sync.pl | 34 ++++++++++ src/test/regress/expected/rules.out | 4 +- 10 files changed, 135 insertions(+), 62 deletions(-) diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 5f4165a945..3c8dca8ca3 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2525,10 +2525,10 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <row> <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>last_inactive_time</structfield> <type>timestamptz</type> + <structfield>inactive_since</structfield> <type>timestamptz</type> </para> <para> - The time at which the slot became inactive. + The time since the slot has become inactive. <literal>NULL</literal> if the slot is currently being used. </para></entry> </row> diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index bc70ff193e..401fb35947 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,7 +1023,7 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, - L.last_inactive_time, + L.inactive_since, L.conflicting, L.invalidation_reason, L.failover, diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index 30480960c5..bbf9a2c485 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -140,6 +140,7 @@ typedef struct RemoteSlot } RemoteSlot; static void slotsync_failure_callback(int code, Datum arg); +static void reset_synced_slots_info(void); /* * If necessary, update the local synced slot's metadata based on the data @@ -1296,6 +1297,45 @@ ReplSlotSyncWorkerMain(char *startup_data, size_t startup_data_len) Assert(false); } +/* + * Reset the synced slots info such as inactive_since after shutting + * down the slot sync machinery. + */ +static void +reset_synced_slots_info(void) +{ + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + for (int i = 0; i < max_replication_slots; i++) + { + ReplicationSlot *s = &ReplicationSlotCtl->replication_slots[i]; + + /* Check if it is a synchronized slot */ + if (s->in_use && s->data.synced) + { + TimestampTz now; + + Assert(SlotIsLogical(s)); + Assert(s->active_pid == 0); + + /* + * Set the time since the slot has become inactive after shutting + * down slot sync machinery. This helps correctly interpret the + * time if the standby gets promoted without a restart. We get the + * current time beforehand to avoid a system call while holding + * the lock. + */ + now = GetCurrentTimestamp(); + + SpinLockAcquire(&s->mutex); + s->inactive_since = now; + SpinLockRelease(&s->mutex); + } + } + + LWLockRelease(ReplicationSlotControlLock); +} + /* * Shut down the slot sync worker. */ @@ -1309,6 +1349,7 @@ ShutDownSlotSync(void) if (SlotSyncCtx->pid == InvalidPid) { SpinLockRelease(&SlotSyncCtx->mutex); + reset_synced_slots_info(); return; } SpinLockRelease(&SlotSyncCtx->mutex); @@ -1341,6 +1382,8 @@ ShutDownSlotSync(void) } SpinLockRelease(&SlotSyncCtx->mutex); + + reset_synced_slots_info(); } /* diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index 45f7a28f7d..d0a2f440ef 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -409,7 +409,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->candidate_restart_valid = InvalidXLogRecPtr; slot->candidate_restart_lsn = InvalidXLogRecPtr; slot->last_saved_confirmed_flush = InvalidXLogRecPtr; - slot->last_inactive_time = 0; + slot->inactive_since = 0; /* * Create the slot on disk. We haven't actually marked the slot allocated @@ -623,9 +623,12 @@ retry: if (SlotIsLogical(s)) pgstat_acquire_replslot(s); - /* Reset the last inactive time as the slot is active now. */ + /* + * Reset the time since the slot has become inactive as the slot is active + * now. + */ SpinLockAcquire(&s->mutex); - s->last_inactive_time = 0; + s->inactive_since = 0; SpinLockRelease(&s->mutex); if (am_walsender) @@ -651,7 +654,7 @@ ReplicationSlotRelease(void) ReplicationSlot *slot = MyReplicationSlot; char *slotname = NULL; /* keep compiler quiet */ bool is_logical = false; /* keep compiler quiet */ - TimestampTz now = 0; + TimestampTz now; Assert(slot != NULL && slot->active_pid != 0); @@ -687,13 +690,11 @@ ReplicationSlotRelease(void) } /* - * Set the last inactive time after marking the slot inactive. We don't - * set it for the slots currently being synced from the primary to the - * standby because such slots are typically inactive as decoding is not - * allowed on those. + * Set the time since the slot has become inactive after marking it + * inactive. We get the current time beforehand to avoid a system call + * while holding the lock. */ - if (!(RecoveryInProgress() && slot->data.synced)) - now = GetCurrentTimestamp(); + now = GetCurrentTimestamp(); if (slot->data.persistency == RS_PERSISTENT) { @@ -703,14 +704,14 @@ ReplicationSlotRelease(void) */ SpinLockAcquire(&slot->mutex); slot->active_pid = 0; - slot->last_inactive_time = now; + slot->inactive_since = now; SpinLockRelease(&slot->mutex); ConditionVariableBroadcast(&slot->active_cv); } else { SpinLockAcquire(&slot->mutex); - slot->last_inactive_time = now; + slot->inactive_since = now; SpinLockRelease(&slot->mutex); } @@ -2366,16 +2367,11 @@ RestoreSlotFromDisk(const char *name) slot->active_pid = 0; /* - * We set the last inactive time after loading the slot from the disk - * into memory. Whoever acquires the slot i.e. makes the slot active - * will reset it. We don't set it for the slots currently being synced - * from the primary to the standby because such slots are typically - * inactive as decoding is not allowed on those. + * We set the time since the slot has become inactive after loading + * the slot from the disk into memory. Whoever acquires the slot i.e. + * makes the slot active will reset it. */ - if (!(RecoveryInProgress() && slot->data.synced)) - slot->last_inactive_time = GetCurrentTimestamp(); - else - slot->last_inactive_time = 0; + slot->inactive_since = GetCurrentTimestamp(); restored = true; break; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 24f5e6d90a..da57177c25 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -410,8 +410,8 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); - if (slot_contents.last_inactive_time > 0) - values[i++] = TimestampTzGetDatum(slot_contents.last_inactive_time); + if (slot_contents.inactive_since > 0) + values[i++] = TimestampTzGetDatum(slot_contents.inactive_since); else nulls[i++] = true; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 0d26e5b422..2f7cfc02c6 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11135,7 +11135,7 @@ proargtypes => '', proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,last_inactive_time,conflicting,invalidation_reason,failover,synced}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,inactive_since,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index eefd7abd39..7b937d1a0c 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -202,8 +202,8 @@ typedef struct ReplicationSlot */ XLogRecPtr last_saved_confirmed_flush; - /* The time at which this slot becomes inactive */ - TimestampTz last_inactive_time; + /* The time since the slot has become inactive */ + TimestampTz inactive_since; } ReplicationSlot; #define SlotIsPhysical(slot) ((slot)->data.database == InvalidOid) diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl index 3409cf88cd..3b9a306a8b 100644 --- a/src/test/recovery/t/019_replslot_limit.pl +++ b/src/test/recovery/t/019_replslot_limit.pl @@ -411,7 +411,7 @@ $node_primary3->stop; $node_standby3->stop; # ============================================================================= -# Testcase start: Check last_inactive_time property of the streaming standby's slot +# Testcase start: Check inactive_since property of the streaming standby's slot # # Initialize primary node @@ -440,45 +440,45 @@ $primary4->safe_psql( SELECT pg_create_physical_replication_slot(slot_name := '$sb4_slot'); ]); -# Get last_inactive_time value after the slot's creation. Note that the slot -# is still inactive till it's used by the standby below. -my $last_inactive_time = - capture_and_validate_slot_last_inactive_time($primary4, $sb4_slot, $slot_creation_time); +# Get inactive_since value after the slot's creation. Note that the slot is +# still inactive till it's used by the standby below. +my $inactive_since = + capture_and_validate_slot_inactive_since($primary4, $sb4_slot, $slot_creation_time); $standby4->start; # Wait until standby has replayed enough data $primary4->wait_for_catchup($standby4); -# Now the slot is active so last_inactive_time value must be NULL +# Now the slot is active so inactive_since value must be NULL is( $primary4->safe_psql( 'postgres', - qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$sb4_slot';] + qq[SELECT inactive_since IS NULL FROM pg_replication_slots WHERE slot_name = '$sb4_slot';] ), 't', 'last inactive time for an active physical slot is NULL'); -# Stop the standby to check its last_inactive_time value is updated +# Stop the standby to check its inactive_since value is updated $standby4->stop; -# Let's restart the primary so that the last_inactive_time is set upon -# loading the slot from the disk. +# Let's restart the primary so that the inactive_since is set upon loading the +# slot from the disk. $primary4->restart; is( $primary4->safe_psql( 'postgres', - qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND last_inactive_time IS NOT NULL;] + qq[SELECT inactive_since > '$inactive_since'::timestamptz FROM pg_replication_slots WHERE slot_name = '$sb4_slot' AND inactive_since IS NOT NULL;] ), 't', 'last inactive time for an inactive physical slot is updated correctly'); $standby4->stop; -# Testcase end: Check last_inactive_time property of the streaming standby's slot +# Testcase end: Check inactive_since property of the streaming standby's slot # ============================================================================= # ============================================================================= -# Testcase start: Check last_inactive_time property of the logical subscriber's slot +# Testcase start: Check inactive_since property of the logical subscriber's slot my $publisher4 = $primary4; # Create subscriber node @@ -499,10 +499,10 @@ $publisher4->safe_psql('postgres', "SELECT pg_create_logical_replication_slot(slot_name := '$lsub4_slot', plugin := 'pgoutput');" ); -# Get last_inactive_time value after the slot's creation. Note that the slot -# is still inactive till it's used by the subscriber below. -$last_inactive_time = - capture_and_validate_slot_last_inactive_time($publisher4, $lsub4_slot, $slot_creation_time); +# Get inactive_since value after the slot's creation. Note that the slot is +# still inactive till it's used by the subscriber below. +$inactive_since = + capture_and_validate_slot_inactive_since($publisher4, $lsub4_slot, $slot_creation_time); $subscriber4->start; $subscriber4->safe_psql('postgres', @@ -512,54 +512,54 @@ $subscriber4->safe_psql('postgres', # Wait until subscriber has caught up $subscriber4->wait_for_subscription_sync($publisher4, 'sub'); -# Now the slot is active so last_inactive_time value must be NULL +# Now the slot is active so inactive_since value must be NULL is( $publisher4->safe_psql( 'postgres', - qq[SELECT last_inactive_time IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub4_slot';] + qq[SELECT inactive_since IS NULL FROM pg_replication_slots WHERE slot_name = '$lsub4_slot';] ), 't', 'last inactive time for an active logical slot is NULL'); -# Stop the subscriber to check its last_inactive_time value is updated +# Stop the subscriber to check its inactive_since value is updated $subscriber4->stop; -# Let's restart the publisher so that the last_inactive_time is set upon +# Let's restart the publisher so that the inactive_since is set upon # loading the slot from the disk. $publisher4->restart; is( $publisher4->safe_psql( 'postgres', - qq[SELECT last_inactive_time > '$last_inactive_time'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND last_inactive_time IS NOT NULL;] + qq[SELECT inactive_since > '$inactive_since'::timestamptz FROM pg_replication_slots WHERE slot_name = '$lsub4_slot' AND inactive_since IS NOT NULL;] ), 't', 'last inactive time for an inactive logical slot is updated correctly'); -# Testcase end: Check last_inactive_time property of the logical subscriber's slot +# Testcase end: Check inactive_since property of the logical subscriber's slot # ============================================================================= $publisher4->stop; $subscriber4->stop; -# Capture and validate last_inactive_time of a given slot. -sub capture_and_validate_slot_last_inactive_time +# Capture and validate inactive_since of a given slot. +sub capture_and_validate_slot_inactive_since { my ($node, $slot_name, $slot_creation_time) = @_; - my $last_inactive_time = $node->safe_psql('postgres', - qq(SELECT last_inactive_time FROM pg_replication_slots - WHERE slot_name = '$slot_name' AND last_inactive_time IS NOT NULL;) + my $inactive_since = $node->safe_psql('postgres', + qq(SELECT inactive_since FROM pg_replication_slots + WHERE slot_name = '$slot_name' AND inactive_since IS NOT NULL;) ); # Check that the captured time is sane is( $node->safe_psql( 'postgres', - qq[SELECT '$last_inactive_time'::timestamptz > to_timestamp(0) AND - '$last_inactive_time'::timestamptz >= '$slot_creation_time'::timestamptz;] + qq[SELECT '$inactive_since'::timestamptz > to_timestamp(0) AND + '$inactive_since'::timestamptz >= '$slot_creation_time'::timestamptz;] ), 't', "last inactive time for an active slot $slot_name is sane"); - return $last_inactive_time; + return $inactive_since; } done_testing(); diff --git a/src/test/recovery/t/040_standby_failover_slots_sync.pl b/src/test/recovery/t/040_standby_failover_slots_sync.pl index f47bfd78eb..e7c33c0066 100644 --- a/src/test/recovery/t/040_standby_failover_slots_sync.pl +++ b/src/test/recovery/t/040_standby_failover_slots_sync.pl @@ -178,6 +178,13 @@ $primary->poll_query_until( # the subscriber. $primary->wait_for_replay_catchup($standby1); +# Capture the time before which the logical failover slots are synced/created +# on the standby. +my $slots_creation_time = $standby1->safe_psql( + 'postgres', qq[ + SELECT current_timestamp; +]); + # Synchronize the primary server slots to the standby. $standby1->safe_psql('postgres', "SELECT pg_sync_replication_slots();"); @@ -190,6 +197,11 @@ is( $standby1->safe_psql( "t", 'logical slots have synced as true on standby'); +# Confirm that the logical failover slots that have synced on the standby has +# got a valid inactive_since value representing the last slot sync time. +capture_and_validate_slot_inactive_since($standby1, 'lsub1_slot', $slots_creation_time); +capture_and_validate_slot_inactive_since($standby1, 'lsub2_slot', $slots_creation_time); + ################################################## # Test that the synchronized slot will be dropped if the corresponding remote # slot on the primary server has been dropped. @@ -773,4 +785,26 @@ is( $subscriber1->safe_psql('postgres', q{SELECT count(*) FROM tab_int;}), "20", 'data replicated from the new primary'); +# Capture and validate inactive_since of a given slot. +sub capture_and_validate_slot_inactive_since +{ + my ($node, $slot_name, $slot_creation_time) = @_; + + my $inactive_since = $node->safe_psql('postgres', + qq(SELECT inactive_since FROM pg_replication_slots + WHERE slot_name = '$slot_name' AND inactive_since IS NOT NULL;) + ); + + # Check that the captured time is sane + is( $node->safe_psql( + 'postgres', + qq[SELECT '$inactive_since'::timestamptz > to_timestamp(0) AND + '$inactive_since'::timestamptz >= '$slot_creation_time'::timestamptz;] + ), + 't', + "last inactive time for a synced slot $slot_name is sane"); + + return $inactive_since; +} + done_testing(); diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index dfcbaec387..f53c3036a6 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,12 +1473,12 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, - l.last_inactive_time, + l.inactive_since, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, last_inactive_time, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, inactive_since, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 [application/x-patch] v22-0002-Allow-setting-inactive_timeout-for-replication-s.patch (34.7K, ../../CALj2ACW-QtWfyC7cUXJsRe_YO50fNj5pKFY5FA7BC3LJv4XNEw@mail.gmail.com/3-v22-0002-Allow-setting-inactive_timeout-for-replication-s.patch) download | inline diff: From bfb5031edf2efefc9461ab649342099925b671e8 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Tue, 26 Mar 2024 08:45:01 +0000 Subject: [PATCH v22 2/3] Allow setting inactive_timeout for replication slots via SQL API. This commit adds a new replication slot property called inactive_timeout specifying the amount of time in seconds the slot is allowed to be inactive. It is added to slot's persistent data structure to survive during server restarts. It will be synced to failover slots on the standby, and also will be carried over to the new cluster as part of pg_upgrade. This commit particularly lets one specify the inactive_timeout for a slot via SQL functions pg_create_physical_replication_slot and pg_create_logical_replication_slot. The new property will be useful to implement inactive timeout based replication slot invalidation in a future commit. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- contrib/test_decoding/expected/slot.out | 97 +++++++++++++++++++ contrib/test_decoding/sql/slot.sql | 30 ++++++ doc/src/sgml/func.sgml | 18 ++-- doc/src/sgml/system-views.sgml | 9 ++ src/backend/catalog/system_functions.sql | 2 + src/backend/catalog/system_views.sql | 1 + src/backend/replication/logical/slotsync.c | 17 +++- src/backend/replication/slot.c | 8 +- src/backend/replication/slotfuncs.c | 31 +++++- src/backend/replication/walsender.c | 4 +- src/bin/pg_upgrade/info.c | 6 +- src/bin/pg_upgrade/pg_upgrade.c | 5 +- src/bin/pg_upgrade/pg_upgrade.h | 2 + src/bin/pg_upgrade/t/003_logical_slots.pl | 11 ++- src/include/catalog/pg_proc.dat | 22 ++--- src/include/replication/slot.h | 5 +- .../t/040_standby_failover_slots_sync.pl | 13 ++- src/test/regress/expected/rules.out | 3 +- 18 files changed, 243 insertions(+), 41 deletions(-) diff --git a/contrib/test_decoding/expected/slot.out b/contrib/test_decoding/expected/slot.out index 349ab2d380..c318eceefd 100644 --- a/contrib/test_decoding/expected/slot.out +++ b/contrib/test_decoding/expected/slot.out @@ -466,3 +466,100 @@ SELECT pg_drop_replication_slot('physical_slot'); (1 row) +-- Test negative value for inactive_timeout option for slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', inactive_timeout := -300); -- error +ERROR: "inactive_timeout" must not be negative +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', inactive_timeout := -600); -- error +ERROR: "inactive_timeout" must not be negative +-- Test inactive_timeout option of physical slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot1', immediately_reserve := true, inactive_timeout := 300); + ?column? +---------- + init +(1 row) + +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot2'); + ?column? +---------- + init +(1 row) + +-- Copy physical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); + ?column? +---------- + copy +(1 row) + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + slot_name | slot_type | inactive_timeout +--------------+-----------+------------------ + it_phy_slot1 | physical | 300 + it_phy_slot2 | physical | 0 + it_phy_slot3 | physical | 300 +(3 rows) + +SELECT pg_drop_replication_slot('it_phy_slot1'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_phy_slot2'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_phy_slot3'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +-- Test inactive_timeout option of logical slots. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); + ?column? +---------- + init +(1 row) + +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2', plugin := 'test_decoding'); + ?column? +---------- + init +(1 row) + +-- Copy logical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); + ?column? +---------- + copy +(1 row) + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + slot_name | slot_type | inactive_timeout +--------------+-----------+------------------ + it_log_slot1 | logical | 600 + it_log_slot2 | logical | 0 + it_log_slot3 | logical | 600 +(3 rows) + +SELECT pg_drop_replication_slot('it_log_slot1'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_log_slot2'); + pg_drop_replication_slot +-------------------------- + +(1 row) + +SELECT pg_drop_replication_slot('it_log_slot3'); + pg_drop_replication_slot +-------------------------- + +(1 row) + diff --git a/contrib/test_decoding/sql/slot.sql b/contrib/test_decoding/sql/slot.sql index 580e3ae3be..e5c7b3d359 100644 --- a/contrib/test_decoding/sql/slot.sql +++ b/contrib/test_decoding/sql/slot.sql @@ -190,3 +190,33 @@ SELECT pg_drop_replication_slot('failover_true_slot'); SELECT pg_drop_replication_slot('failover_false_slot'); SELECT pg_drop_replication_slot('failover_default_slot'); SELECT pg_drop_replication_slot('physical_slot'); + +-- Test negative value for inactive_timeout option for slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_fail_slot', inactive_timeout := -300); -- error +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_fail_slot', plugin := 'test_decoding', inactive_timeout := -600); -- error + +-- Test inactive_timeout option of physical slots. +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot1', immediately_reserve := true, inactive_timeout := 300); +SELECT 'init' FROM pg_create_physical_replication_slot(slot_name := 'it_phy_slot2'); + +-- Copy physical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_physical_replication_slot(src_slot_name := 'it_phy_slot1', dst_slot_name := 'it_phy_slot3'); + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + +SELECT pg_drop_replication_slot('it_phy_slot1'); +SELECT pg_drop_replication_slot('it_phy_slot2'); +SELECT pg_drop_replication_slot('it_phy_slot3'); + +-- Test inactive_timeout option of logical slots. +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot1', plugin := 'test_decoding', inactive_timeout := 600); +SELECT 'init' FROM pg_create_logical_replication_slot(slot_name := 'it_log_slot2', plugin := 'test_decoding'); + +-- Copy logical slot with inactive_timeout option set. +SELECT 'copy' FROM pg_copy_logical_replication_slot(src_slot_name := 'it_log_slot1', dst_slot_name := 'it_log_slot3'); + +SELECT slot_name, slot_type, inactive_timeout FROM pg_replication_slots ORDER BY 1; + +SELECT pg_drop_replication_slot('it_log_slot1'); +SELECT pg_drop_replication_slot('it_log_slot2'); +SELECT pg_drop_replication_slot('it_log_slot3'); diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 8ecc02f2b9..2cc26e927a 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28373,7 +28373,7 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <indexterm> <primary>pg_create_physical_replication_slot</primary> </indexterm> - <function>pg_create_physical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type> <optional>, <parameter>immediately_reserve</parameter> <type>boolean</type>, <parameter>temporary</parameter> <type>boolean</type> </optional> ) + <function>pg_create_physical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type> <optional>, <parameter>immediately_reserve</parameter> <type>boolean</type>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>inactive_timeout</parameter> <type>integer</type> </optional>) <returnvalue>record</returnvalue> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>lsn</parameter> <type>pg_lsn</type> ) @@ -28390,9 +28390,12 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset parameter, <parameter>temporary</parameter>, when set to true, specifies that the slot should not be permanently stored to disk and is only meant for use by the current session. Temporary slots are also - released upon any error. This function corresponds - to the replication protocol command <literal>CREATE_REPLICATION_SLOT - ... PHYSICAL</literal>. + released upon any error. The optional fourth + parameter, <parameter>inactive_timeout</parameter>, when set to a + non-zero value, specifies the amount of time in seconds the slot is + allowed to be inactive. This function corresponds to the replication + protocol command + <literal>CREATE_REPLICATION_SLOT ... PHYSICAL</literal>. </para></entry> </row> @@ -28417,7 +28420,7 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <indexterm> <primary>pg_create_logical_replication_slot</primary> </indexterm> - <function>pg_create_logical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>plugin</parameter> <type>name</type> <optional>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>twophase</parameter> <type>boolean</type>, <parameter>failover</parameter> <type>boolean</type> </optional> ) + <function>pg_create_logical_replication_slot</function> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>plugin</parameter> <type>name</type> <optional>, <parameter>temporary</parameter> <type>boolean</type>, <parameter>twophase</parameter> <type>boolean</type>, <parameter>failover</parameter> <type>boolean</type>, <parameter>inactive_timeout</parameter> <type>integer</type> </optional> ) <returnvalue>record</returnvalue> ( <parameter>slot_name</parameter> <type>name</type>, <parameter>lsn</parameter> <type>pg_lsn</type> ) @@ -28436,7 +28439,10 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset <parameter>failover</parameter>, when set to true, specifies that this slot is enabled to be synced to the standbys so that logical replication can be resumed after - failover. A call to this function has the same effect as + failover. The optional sixth parameter, + <parameter>inactive_timeout</parameter>, when set to a + non-zero value, specifies the amount of time in seconds the slot is + allowed to be inactive. A call to this function has the same effect as the replication protocol command <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. </para></entry> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 3c8dca8ca3..a6cb13fd9d 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2523,6 +2523,15 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx </para></entry> </row> + <row> + <entry role="catalog_table_entry"><para role="column_definition"> + <structfield>inactive_timeout</structfield> <type>integer</type> + </para> + <para> + The amount of time in seconds the slot is allowed to be inactive. + </para></entry> + </row> + <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>inactive_since</structfield> <type>timestamptz</type> diff --git a/src/backend/catalog/system_functions.sql b/src/backend/catalog/system_functions.sql index fe2bb50f46..af27616657 100644 --- a/src/backend/catalog/system_functions.sql +++ b/src/backend/catalog/system_functions.sql @@ -469,6 +469,7 @@ AS 'pg_logical_emit_message_bytea'; CREATE OR REPLACE FUNCTION pg_create_physical_replication_slot( IN slot_name name, IN immediately_reserve boolean DEFAULT false, IN temporary boolean DEFAULT false, + IN inactive_timeout int DEFAULT 0, OUT slot_name name, OUT lsn pg_lsn) RETURNS RECORD LANGUAGE INTERNAL @@ -480,6 +481,7 @@ CREATE OR REPLACE FUNCTION pg_create_logical_replication_slot( IN temporary boolean DEFAULT false, IN twophase boolean DEFAULT false, IN failover boolean DEFAULT false, + IN inactive_timeout int DEFAULT 0, OUT slot_name name, OUT lsn pg_lsn) RETURNS RECORD LANGUAGE INTERNAL diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index 401fb35947..7d9d743dd5 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1023,6 +1023,7 @@ CREATE VIEW pg_replication_slots AS L.wal_status, L.safe_wal_size, L.two_phase, + L.inactive_timeout, L.inactive_since, L.conflicting, L.invalidation_reason, diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index bbf9a2c485..79a968373c 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -131,6 +131,7 @@ typedef struct RemoteSlot char *database; bool two_phase; bool failover; + int inactive_timeout; /* in seconds */ XLogRecPtr restart_lsn; XLogRecPtr confirmed_lsn; TransactionId catalog_xmin; @@ -168,7 +169,8 @@ update_local_synced_slot(RemoteSlot *remote_slot, Oid remote_dbid) remote_slot->two_phase == slot->data.two_phase && remote_slot->failover == slot->data.failover && remote_slot->confirmed_lsn == slot->data.confirmed_flush && - strcmp(remote_slot->plugin, NameStr(slot->data.plugin)) == 0) + strcmp(remote_slot->plugin, NameStr(slot->data.plugin)) == 0 && + remote_slot->inactive_timeout == slot->data.inactive_timeout) return false; /* Avoid expensive operations while holding a spinlock. */ @@ -183,6 +185,7 @@ update_local_synced_slot(RemoteSlot *remote_slot, Oid remote_dbid) slot->data.confirmed_flush = remote_slot->confirmed_lsn; slot->data.catalog_xmin = remote_slot->catalog_xmin; slot->effective_catalog_xmin = remote_slot->catalog_xmin; + slot->data.inactive_timeout = remote_slot->inactive_timeout; SpinLockRelease(&slot->mutex); if (xmin_changed) @@ -608,7 +611,8 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) ReplicationSlotCreate(remote_slot->name, true, RS_TEMPORARY, remote_slot->two_phase, remote_slot->failover, - true); + true, + remote_slot->inactive_timeout); /* For shorter lines. */ slot = MyReplicationSlot; @@ -653,9 +657,9 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) static bool synchronize_slots(WalReceiverConn *wrconn) { -#define SLOTSYNC_COLUMN_COUNT 9 +#define SLOTSYNC_COLUMN_COUNT 10 Oid slotRow[SLOTSYNC_COLUMN_COUNT] = {TEXTOID, TEXTOID, LSNOID, - LSNOID, XIDOID, BOOLOID, BOOLOID, TEXTOID, TEXTOID}; + LSNOID, XIDOID, BOOLOID, BOOLOID, TEXTOID, TEXTOID, INT4OID}; WalRcvExecResult *res; TupleTableSlot *tupslot; @@ -664,7 +668,7 @@ synchronize_slots(WalReceiverConn *wrconn) bool started_tx = false; const char *query = "SELECT slot_name, plugin, confirmed_flush_lsn," " restart_lsn, catalog_xmin, two_phase, failover," - " database, invalidation_reason" + " database, invalidation_reason, inactive_timeout" " FROM pg_catalog.pg_replication_slots" " WHERE failover and NOT temporary"; @@ -744,6 +748,9 @@ synchronize_slots(WalReceiverConn *wrconn) remote_slot->invalidated = isnull ? RS_INVAL_NONE : GetSlotInvalidationCause(TextDatumGetCString(d)); + remote_slot->inactive_timeout = DatumGetInt32(slot_getattr(tupslot, ++col, + &isnull)); + /* Sanity check */ Assert(col == SLOTSYNC_COLUMN_COUNT); diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index d0a2f440ef..bc7424bac3 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -129,7 +129,7 @@ StaticAssertDecl(lengthof(SlotInvalidationCauses) == (RS_INVAL_MAX_CAUSES + 1), sizeof(ReplicationSlotOnDisk) - ReplicationSlotOnDiskConstantSize #define SLOT_MAGIC 0x1051CA1 /* format identifier */ -#define SLOT_VERSION 5 /* version for new files */ +#define SLOT_VERSION 6 /* version for new files */ /* Control array for replication slot management */ ReplicationSlotCtlData *ReplicationSlotCtl = NULL; @@ -304,11 +304,14 @@ ReplicationSlotValidateName(const char *name, int elevel) * failover: If enabled, allows the slot to be synced to standbys so * that logical replication can be resumed after failover. * synced: True if the slot is synchronized from the primary server. + * inactive_timeout: The amount of time in seconds the slot is allowed to be + * inactive. */ void ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, - bool two_phase, bool failover, bool synced) + bool two_phase, bool failover, bool synced, + int inactive_timeout) { ReplicationSlot *slot = NULL; int i; @@ -398,6 +401,7 @@ ReplicationSlotCreate(const char *name, bool db_specific, slot->data.two_phase_at = InvalidXLogRecPtr; slot->data.failover = failover; slot->data.synced = synced; + slot->data.inactive_timeout = inactive_timeout; /* and then data only present in shared memory */ slot->just_dirtied = false; diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index da57177c25..6e1d8d1f9a 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -38,14 +38,15 @@ */ static void create_physical_replication_slot(char *name, bool immediately_reserve, - bool temporary, XLogRecPtr restart_lsn) + bool temporary, int inactive_timeout, + XLogRecPtr restart_lsn) { Assert(!MyReplicationSlot); /* acquire replication slot, this will check for conflicting names */ ReplicationSlotCreate(name, false, temporary ? RS_TEMPORARY : RS_PERSISTENT, false, - false, false); + false, false, inactive_timeout); if (immediately_reserve) { @@ -71,6 +72,7 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) Name name = PG_GETARG_NAME(0); bool immediately_reserve = PG_GETARG_BOOL(1); bool temporary = PG_GETARG_BOOL(2); + int inactive_timeout = PG_GETARG_INT32(3); /* in seconds */ Datum values[2]; bool nulls[2]; TupleDesc tupdesc; @@ -84,9 +86,15 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) CheckSlotRequirements(); + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + create_physical_replication_slot(NameStr(*name), immediately_reserve, temporary, + inactive_timeout, InvalidXLogRecPtr); values[0] = NameGetDatum(&MyReplicationSlot->data.name); @@ -120,7 +128,7 @@ pg_create_physical_replication_slot(PG_FUNCTION_ARGS) static void create_logical_replication_slot(char *name, char *plugin, bool temporary, bool two_phase, - bool failover, + bool failover, int inactive_timeout, XLogRecPtr restart_lsn, bool find_startpoint) { @@ -138,7 +146,7 @@ create_logical_replication_slot(char *name, char *plugin, */ ReplicationSlotCreate(name, true, temporary ? RS_TEMPORARY : RS_EPHEMERAL, two_phase, - failover, false); + failover, false, inactive_timeout); /* * Create logical decoding context to find start point or, if we don't @@ -177,6 +185,7 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) bool temporary = PG_GETARG_BOOL(2); bool two_phase = PG_GETARG_BOOL(3); bool failover = PG_GETARG_BOOL(4); + int inactive_timeout = PG_GETARG_INT32(5); /* in seconds */ Datum result; TupleDesc tupdesc; HeapTuple tuple; @@ -190,11 +199,17 @@ pg_create_logical_replication_slot(PG_FUNCTION_ARGS) CheckLogicalDecodingRequirements(); + if (inactive_timeout < 0) + ereport(ERROR, + (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE), + errmsg("\"inactive_timeout\" must not be negative"))); + create_logical_replication_slot(NameStr(*name), NameStr(*plugin), temporary, two_phase, failover, + inactive_timeout, InvalidXLogRecPtr, true); @@ -239,7 +254,7 @@ pg_drop_replication_slot(PG_FUNCTION_ARGS) Datum pg_get_replication_slots(PG_FUNCTION_ARGS) { -#define PG_GET_REPLICATION_SLOTS_COLS 19 +#define PG_GET_REPLICATION_SLOTS_COLS 20 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; @@ -410,6 +425,8 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) values[i++] = BoolGetDatum(slot_contents.data.two_phase); + values[i++] = Int32GetDatum(slot_contents.data.inactive_timeout); + if (slot_contents.inactive_since > 0) values[i++] = TimestampTzGetDatum(slot_contents.inactive_since); else @@ -720,6 +737,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) XLogRecPtr src_restart_lsn; bool src_islogical; bool temporary; + int inactive_timeout; /* in seconds */ char *plugin; Datum values[2]; bool nulls[2]; @@ -776,6 +794,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) src_restart_lsn = first_slot_contents.data.restart_lsn; temporary = (first_slot_contents.data.persistency == RS_TEMPORARY); plugin = logical_slot ? NameStr(first_slot_contents.data.plugin) : NULL; + inactive_timeout = first_slot_contents.data.inactive_timeout; /* Check type of replication slot */ if (src_islogical != logical_slot) @@ -823,6 +842,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) temporary, false, false, + inactive_timeout, src_restart_lsn, false); } @@ -830,6 +850,7 @@ copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot) create_physical_replication_slot(NameStr(*dst_name), true, temporary, + inactive_timeout, src_restart_lsn); /* diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index bc40c454de..5315c08650 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -1221,7 +1221,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) { ReplicationSlotCreate(cmd->slotname, false, cmd->temporary ? RS_TEMPORARY : RS_PERSISTENT, - false, false, false); + false, false, false, 0); if (reserve_wal) { @@ -1252,7 +1252,7 @@ CreateReplicationSlot(CreateReplicationSlotCmd *cmd) */ ReplicationSlotCreate(cmd->slotname, true, cmd->temporary ? RS_TEMPORARY : RS_EPHEMERAL, - two_phase, failover, false); + two_phase, failover, false, 0); /* * Do options check early so that we can bail before calling the diff --git a/src/bin/pg_upgrade/info.c b/src/bin/pg_upgrade/info.c index 95c22a7200..12626987f0 100644 --- a/src/bin/pg_upgrade/info.c +++ b/src/bin/pg_upgrade/info.c @@ -676,7 +676,8 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) * removed. */ res = executeQueryOrDie(conn, "SELECT slot_name, plugin, two_phase, failover, " - "%s as caught_up, invalidation_reason IS NOT NULL as invalid " + "%s as caught_up, invalidation_reason IS NOT NULL as invalid, " + "inactive_timeout " "FROM pg_catalog.pg_replication_slots " "WHERE slot_type = 'logical' AND " "database = current_database() AND " @@ -696,6 +697,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) int i_failover; int i_caught_up; int i_invalid; + int i_inactive_timeout; slotinfos = (LogicalSlotInfo *) pg_malloc(sizeof(LogicalSlotInfo) * num_slots); @@ -705,6 +707,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) i_failover = PQfnumber(res, "failover"); i_caught_up = PQfnumber(res, "caught_up"); i_invalid = PQfnumber(res, "invalid"); + i_inactive_timeout = PQfnumber(res, "inactive_timeout"); for (int slotnum = 0; slotnum < num_slots; slotnum++) { @@ -716,6 +719,7 @@ get_old_cluster_logical_slot_infos(DbInfo *dbinfo, bool live_check) curr->failover = (strcmp(PQgetvalue(res, slotnum, i_failover), "t") == 0); curr->caught_up = (strcmp(PQgetvalue(res, slotnum, i_caught_up), "t") == 0); curr->invalid = (strcmp(PQgetvalue(res, slotnum, i_invalid), "t") == 0); + curr->inactive_timeout = atooid(PQgetvalue(res, slotnum, i_inactive_timeout)); } } diff --git a/src/bin/pg_upgrade/pg_upgrade.c b/src/bin/pg_upgrade/pg_upgrade.c index f6143b6bc4..2656056103 100644 --- a/src/bin/pg_upgrade/pg_upgrade.c +++ b/src/bin/pg_upgrade/pg_upgrade.c @@ -931,9 +931,10 @@ create_logical_replication_slots(void) appendPQExpBuffer(query, ", "); appendStringLiteralConn(query, slot_info->plugin, conn); - appendPQExpBuffer(query, ", false, %s, %s);", + appendPQExpBuffer(query, ", false, %s, %s, %d);", slot_info->two_phase ? "true" : "false", - slot_info->failover ? "true" : "false"); + slot_info->failover ? "true" : "false", + slot_info->inactive_timeout); PQclear(executeQueryOrDie(conn, "%s", query->data)); diff --git a/src/bin/pg_upgrade/pg_upgrade.h b/src/bin/pg_upgrade/pg_upgrade.h index 92bcb693fb..eb86d000b1 100644 --- a/src/bin/pg_upgrade/pg_upgrade.h +++ b/src/bin/pg_upgrade/pg_upgrade.h @@ -162,6 +162,8 @@ typedef struct bool invalid; /* if true, the slot is unusable */ bool failover; /* is the slot designated to be synced to the * physical standby? */ + int inactive_timeout; /* The amount of time in seconds the slot + * is allowed to be inactive. */ } LogicalSlotInfo; typedef struct diff --git a/src/bin/pg_upgrade/t/003_logical_slots.pl b/src/bin/pg_upgrade/t/003_logical_slots.pl index 83d71c3084..6e82d2cb7b 100644 --- a/src/bin/pg_upgrade/t/003_logical_slots.pl +++ b/src/bin/pg_upgrade/t/003_logical_slots.pl @@ -153,14 +153,17 @@ like( # TEST: Successful upgrade # Preparations for the subsequent test: -# 1. Setup logical replication (first, cleanup slots from the previous tests) +# 1. Setup logical replication (first, cleanup slots from the previous tests, +# and then create slot for this test with inactive_timeout set). my $old_connstr = $oldpub->connstr . ' dbname=postgres'; +my $inactive_timeout = 3600; $oldpub->start; $oldpub->safe_psql( 'postgres', qq[ SELECT * FROM pg_drop_replication_slot('test_slot1'); SELECT * FROM pg_drop_replication_slot('test_slot2'); + SELECT pg_create_logical_replication_slot(slot_name := 'regress_sub', plugin := 'pgoutput', inactive_timeout := $inactive_timeout); CREATE PUBLICATION regress_pub FOR ALL TABLES; ]); @@ -172,7 +175,7 @@ $sub->start; $sub->safe_psql( 'postgres', qq[ CREATE TABLE tbl (a int); - CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (two_phase = 'true', failover = 'true') + CREATE SUBSCRIPTION regress_sub CONNECTION '$old_connstr' PUBLICATION regress_pub WITH (slot_name = 'regress_sub', create_slot = false, two_phase = 'true', failover = 'true') ]); $sub->wait_for_subscription_sync($oldpub, 'regress_sub'); @@ -192,8 +195,8 @@ command_ok([@pg_upgrade_cmd], 'run of pg_upgrade of old cluster'); # Check that the slot 'regress_sub' has migrated to the new cluster $newpub->start; my $result = $newpub->safe_psql('postgres', - "SELECT slot_name, two_phase, failover FROM pg_replication_slots"); -is($result, qq(regress_sub|t|t), 'check the slot exists on new cluster'); + "SELECT slot_name, two_phase, failover, inactive_timeout = $inactive_timeout FROM pg_replication_slots"); +is($result, qq(regress_sub|t|t|t), 'check the slot exists on new cluster'); # Update the connection my $new_connstr = $newpub->connstr . ' dbname=postgres'; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 2f7cfc02c6..ea4ffb509a 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11105,10 +11105,10 @@ # replication slots { oid => '3779', descr => 'create a physical replication slot', proname => 'pg_create_physical_replication_slot', provolatile => 'v', - proparallel => 'u', prorettype => 'record', proargtypes => 'name bool bool', - proallargtypes => '{name,bool,bool,name,pg_lsn}', - proargmodes => '{i,i,i,o,o}', - proargnames => '{slot_name,immediately_reserve,temporary,slot_name,lsn}', + proparallel => 'u', prorettype => 'record', proargtypes => 'name bool bool int4', + proallargtypes => '{name,bool,bool,int4,name,pg_lsn}', + proargmodes => '{i,i,i,i,o,o}', + proargnames => '{slot_name,immediately_reserve,temporary,inactive_timeout,slot_name,lsn}', prosrc => 'pg_create_physical_replication_slot' }, { oid => '4220', descr => 'copy a physical replication slot, changing temporality', @@ -11133,17 +11133,17 @@ proname => 'pg_get_replication_slots', prorows => '10', proisstrict => 'f', proretset => 't', provolatile => 's', prorettype => 'record', proargtypes => '', - proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,timestamptz,bool,text,bool,bool}', - proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', - proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,inactive_since,conflicting,invalidation_reason,failover,synced}', + proallargtypes => '{name,name,text,oid,bool,bool,int4,xid,xid,pg_lsn,pg_lsn,text,int8,bool,int4,timestamptz,bool,text,bool,bool}', + proargmodes => '{o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o,o}', + proargnames => '{slot_name,plugin,slot_type,datoid,temporary,active,active_pid,xmin,catalog_xmin,restart_lsn,confirmed_flush_lsn,wal_status,safe_wal_size,two_phase,inactive_timeout,inactive_since,conflicting,invalidation_reason,failover,synced}', prosrc => 'pg_get_replication_slots' }, { oid => '3786', descr => 'set up a logical replication slot', proname => 'pg_create_logical_replication_slot', provolatile => 'v', proparallel => 'u', prorettype => 'record', - proargtypes => 'name name bool bool bool', - proallargtypes => '{name,name,bool,bool,bool,name,pg_lsn}', - proargmodes => '{i,i,i,i,i,o,o}', - proargnames => '{slot_name,plugin,temporary,twophase,failover,slot_name,lsn}', + proargtypes => 'name name bool bool bool int4', + proallargtypes => '{name,name,bool,bool,bool,int4,name,pg_lsn}', + proargmodes => '{i,i,i,i,i,i,o,o}', + proargnames => '{slot_name,plugin,temporary,twophase,failover,inactive_timeout,slot_name,lsn}', prosrc => 'pg_create_logical_replication_slot' }, { oid => '4222', descr => 'copy a logical replication slot, changing temporality and plugin', diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 7b937d1a0c..5a812ef528 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -127,6 +127,9 @@ typedef struct ReplicationSlotPersistentData * for logical slots on the primary server. */ bool failover; + + /* The amount of time in seconds the slot is allowed to be inactive */ + int inactive_timeout; } ReplicationSlotPersistentData; /* @@ -239,7 +242,7 @@ extern void ReplicationSlotsShmemInit(void); extern void ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, bool two_phase, bool failover, - bool synced); + bool synced, int inactive_timeout); extern void ReplicationSlotPersist(void); extern void ReplicationSlotDrop(const char *name, bool nowait); extern void ReplicationSlotDropAcquired(void); diff --git a/src/test/recovery/t/040_standby_failover_slots_sync.pl b/src/test/recovery/t/040_standby_failover_slots_sync.pl index e7c33c0066..a6fb0f1040 100644 --- a/src/test/recovery/t/040_standby_failover_slots_sync.pl +++ b/src/test/recovery/t/040_standby_failover_slots_sync.pl @@ -152,8 +152,9 @@ log_min_messages = 'debug2' $primary->append_conf('postgresql.conf', "log_min_messages = 'debug2'"); $primary->reload; +my $inactive_timeout = 3600; $primary->psql('postgres', - q{SELECT pg_create_logical_replication_slot('lsub2_slot', 'test_decoding', false, false, true);} + "SELECT pg_create_logical_replication_slot('lsub2_slot', 'test_decoding', false, false, true, $inactive_timeout);" ); $primary->psql('postgres', @@ -202,6 +203,16 @@ is( $standby1->safe_psql( capture_and_validate_slot_inactive_since($standby1, 'lsub1_slot', $slots_creation_time); capture_and_validate_slot_inactive_since($standby1, 'lsub2_slot', $slots_creation_time); +# Confirm that the synced slot on the standby has got inactive_timeout from the +# primary. +is( $standby1->safe_psql( + 'postgres', + "SELECT inactive_timeout = $inactive_timeout FROM pg_replication_slots + WHERE slot_name = 'lsub2_slot' AND synced AND NOT temporary;" + ), + "t", + 'synced logical slot has got inactive_timeout on standby'); + ################################################## # Test that the synchronized slot will be dropped if the corresponding remote # slot on the primary server has been dropped. diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index f53c3036a6..7f3b70f598 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -1473,12 +1473,13 @@ pg_replication_slots| SELECT l.slot_name, l.wal_status, l.safe_wal_size, l.two_phase, + l.inactive_timeout, l.inactive_since, l.conflicting, l.invalidation_reason, l.failover, l.synced - FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, inactive_since, conflicting, invalidation_reason, failover, synced) + FROM (pg_get_replication_slots() l(slot_name, plugin, slot_type, datoid, temporary, active, active_pid, xmin, catalog_xmin, restart_lsn, confirmed_flush_lsn, wal_status, safe_wal_size, two_phase, inactive_timeout, inactive_since, conflicting, invalidation_reason, failover, synced) LEFT JOIN pg_database d ON ((l.datoid = d.oid))); pg_roles| SELECT pg_authid.rolname, pg_authid.rolsuper, -- 2.34.1 [application/x-patch] v22-0003-Add-inactive_timeout-based-replication-slot-inva.patch (26.0K, ../../CALj2ACW-QtWfyC7cUXJsRe_YO50fNj5pKFY5FA7BC3LJv4XNEw@mail.gmail.com/4-v22-0003-Add-inactive_timeout-based-replication-slot-inva.patch) download | inline diff: From 0701c1bc0d61a812e052697d81f49cb9ca23f194 Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy <[email protected]> Date: Tue, 26 Mar 2024 08:54:13 +0000 Subject: [PATCH v22 3/3] Add inactive_timeout based replication slot invalidation. Till now, postgres has the ability to invalidate inactive replication slots based on the amount of WAL (set via max_slot_wal_keep_size GUC) that will be needed for the slots in case they become active. However, choosing a default value for max_slot_wal_keep_size is tricky. Because the amount of WAL a customer generates, and their allocated storage will vary greatly in production, making it difficult to pin down a one-size-fits-all value. It is often easy for developers to set a timeout of say 1 or 2 or 3 days at slot level, after which the inactive slots get dropped. To achieve the above, postgres uses replication slot property last_inactive_time (the time at which the slot became inactive), and a new slot level parameter inactive_timeout and finds an opportunity to invalidate the slot based on this new mechanism. The invalidation check happens at various locations to help being as latest as possible, these locations include the following: - Whenever the slot is acquired if the slot gets invalidated due to this new mechanism, an error is emitted. - During checkpoint. Note that this new invalidation mechanism won't kick-in for the slots that are currently being synced from the primary to the standby. Author: Bharath Rupireddy Reviewed-by: Bertrand Drouvot, Amit Kapila, Shveta Malik Discussion: https://www.postgresql.org/message-id/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com --- doc/src/sgml/func.sgml | 8 +- doc/src/sgml/system-views.sgml | 10 +- .../replication/logical/logicalfuncs.c | 2 +- src/backend/replication/logical/slotsync.c | 4 +- src/backend/replication/slot.c | 176 +++++++++++++++++- src/backend/replication/slotfuncs.c | 12 +- src/backend/replication/walsender.c | 4 +- src/backend/utils/adt/pg_upgrade_support.c | 2 +- src/bin/pg_upgrade/pg_upgrade.h | 3 +- src/include/replication/slot.h | 8 +- src/test/recovery/meson.build | 1 + src/test/recovery/t/050_invalidate_slots.pl | 169 +++++++++++++++++ 12 files changed, 380 insertions(+), 19 deletions(-) create mode 100644 src/test/recovery/t/050_invalidate_slots.pl diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 2cc26e927a..fb1640ae12 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -28393,8 +28393,8 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset released upon any error. The optional fourth parameter, <parameter>inactive_timeout</parameter>, when set to a non-zero value, specifies the amount of time in seconds the slot is - allowed to be inactive. This function corresponds to the replication - protocol command + allowed to be inactive before getting invalidated. + This function corresponds to the replication protocol command <literal>CREATE_REPLICATION_SLOT ... PHYSICAL</literal>. </para></entry> </row> @@ -28442,8 +28442,8 @@ postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset failover. The optional sixth parameter, <parameter>inactive_timeout</parameter>, when set to a non-zero value, specifies the amount of time in seconds the slot is - allowed to be inactive. A call to this function has the same effect as - the replication protocol command + allowed to be inactive before getting invalidated. A call to this + function has the same effect as the replication protocol command <literal>CREATE_REPLICATION_SLOT ... LOGICAL</literal>. </para></entry> </row> diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index a6cb13fd9d..3b09838a0b 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -2528,7 +2528,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx <structfield>inactive_timeout</structfield> <type>integer</type> </para> <para> - The amount of time in seconds the slot is allowed to be inactive. + The amount of time in seconds the slot is allowed to be inactive + before getting invalidated. </para></entry> </row> @@ -2582,6 +2583,13 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx perform logical decoding. It is set only for logical slots. </para> </listitem> + <listitem> + <para> + <literal>inactive_timeout</literal> means that the slot has been + inactive for the duration specified by slot's + <literal>inactive_timeout</literal> parameter. + </para> + </listitem> </itemizedlist> </para></entry> </row> diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c index b4dd5cce75..56fc1a45a9 100644 --- a/src/backend/replication/logical/logicalfuncs.c +++ b/src/backend/replication/logical/logicalfuncs.c @@ -197,7 +197,7 @@ pg_logical_slot_get_changes_guts(FunctionCallInfo fcinfo, bool confirm, bool bin else end_of_wal = GetXLogReplayRecPtr(NULL); - ReplicationSlotAcquire(NameStr(*name), true); + ReplicationSlotAcquire(NameStr(*name), true, true); PG_TRY(); { diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c index 79a968373c..e94ac0f13f 100644 --- a/src/backend/replication/logical/slotsync.c +++ b/src/backend/replication/logical/slotsync.c @@ -320,7 +320,7 @@ drop_local_obsolete_slots(List *remote_slot_list) if (synced_slot) { - ReplicationSlotAcquire(NameStr(local_slot->data.name), true); + ReplicationSlotAcquire(NameStr(local_slot->data.name), true, false); ReplicationSlotDropAcquired(); } @@ -530,7 +530,7 @@ synchronize_one_slot(RemoteSlot *remote_slot, Oid remote_dbid) * InvalidatePossiblyObsoleteSlot() where it invalidates slot directly * if the slot is not acquired by other processes. */ - ReplicationSlotAcquire(remote_slot->name, true); + ReplicationSlotAcquire(remote_slot->name, true, false); Assert(slot == MyReplicationSlot); diff --git a/src/backend/replication/slot.c b/src/backend/replication/slot.c index bc7424bac3..0d7f2c0f50 100644 --- a/src/backend/replication/slot.c +++ b/src/backend/replication/slot.c @@ -107,10 +107,11 @@ const char *const SlotInvalidationCauses[] = { [RS_INVAL_WAL_REMOVED] = "wal_removed", [RS_INVAL_HORIZON] = "rows_removed", [RS_INVAL_WAL_LEVEL] = "wal_level_insufficient", + [RS_INVAL_INACTIVE_TIMEOUT] = "inactive_timeout", }; /* Maximum number of invalidation causes */ -#define RS_INVAL_MAX_CAUSES RS_INVAL_WAL_LEVEL +#define RS_INVAL_MAX_CAUSES RS_INVAL_INACTIVE_TIMEOUT StaticAssertDecl(lengthof(SlotInvalidationCauses) == (RS_INVAL_MAX_CAUSES + 1), "array length mismatch"); @@ -158,6 +159,8 @@ static XLogRecPtr ss_oldest_flush_lsn = InvalidXLogRecPtr; static void ReplicationSlotShmemExit(int code, Datum arg); static void ReplicationSlotDropPtr(ReplicationSlot *slot); +static bool InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_locks); /* internal persistency functions */ static void RestoreSlotFromDisk(const char *name); @@ -305,7 +308,7 @@ ReplicationSlotValidateName(const char *name, int elevel) * that logical replication can be resumed after failover. * synced: True if the slot is synchronized from the primary server. * inactive_timeout: The amount of time in seconds the slot is allowed to be - * inactive. + * inactive before getting invalidated. */ void ReplicationSlotCreate(const char *name, bool db_specific, @@ -539,9 +542,14 @@ ReplicationSlotName(int index, Name name) * * An error is raised if nowait is true and the slot is currently in use. If * nowait is false, we sleep until the slot is released by the owning process. + * + * If check_for_invalidation is true, the slot is checked for invalidation + * based on its inactive_timeout parameter and an error is raised after making + * the slot ours. */ void -ReplicationSlotAcquire(const char *name, bool nowait) +ReplicationSlotAcquire(const char *name, bool nowait, + bool check_for_invalidation) { ReplicationSlot *s; int active_pid; @@ -619,6 +627,42 @@ retry: /* We made this slot active, so it's ours now. */ MyReplicationSlot = s; + /* + * Check if the given slot can be invalidated based on its + * inactive_timeout parameter. If yes, persist the invalidated state to + * disk and then error out. We do this only after making the slot ours to + * avoid anyone else acquiring it while we check for its invalidation. + */ + if (check_for_invalidation) + { + /* The slot is ours by now */ + Assert(s->active_pid == MyProcPid); + + /* + * Well, the slot is not yet ours really unless we check for the + * invalidation below. + */ + s->active_pid = 0; + if (InvalidateReplicationSlotForInactiveTimeout(s, true, true)) + { + /* + * If the slot has been invalidated, recalculate the resource + * limits. + */ + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + + /* Might need it for slot clean up on error, so restore it */ + s->active_pid = MyProcPid; + ereport(ERROR, + (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), + errmsg("cannot acquire invalidated replication slot \"%s\"", + NameStr(MyReplicationSlot->data.name)), + errdetail("This slot has been invalidated because of its inactive_timeout parameter."))); + } + s->active_pid = MyProcPid; + } + /* * The call to pgstat_acquire_replslot() protects against stats for a * different slot, from before a restart or such, being present during @@ -786,7 +830,7 @@ ReplicationSlotDrop(const char *name, bool nowait) { Assert(MyReplicationSlot == NULL); - ReplicationSlotAcquire(name, nowait); + ReplicationSlotAcquire(name, nowait, false); /* * Do not allow users to drop the slots which are currently being synced @@ -809,7 +853,7 @@ ReplicationSlotAlter(const char *name, bool failover) { Assert(MyReplicationSlot == NULL); - ReplicationSlotAcquire(name, false); + ReplicationSlotAcquire(name, false, true); if (SlotIsPhysical(MyReplicationSlot)) ereport(ERROR, @@ -1511,6 +1555,9 @@ ReportSlotInvalidation(ReplicationSlotInvalidationCause cause, case RS_INVAL_WAL_LEVEL: appendStringInfoString(&err_detail, _("Logical decoding on standby requires wal_level >= logical on the primary server.")); break; + case RS_INVAL_INACTIVE_TIMEOUT: + appendStringInfoString(&err_detail, _("The slot has been inactive for more than the time specified by slot's inactive_timeout parameter.")); + break; case RS_INVAL_NONE: pg_unreachable(); } @@ -1624,6 +1671,10 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, if (SlotIsLogical(s)) invalidation_cause = cause; break; + case RS_INVAL_INACTIVE_TIMEOUT: + if (InvalidateReplicationSlotForInactiveTimeout(s, false, false)) + invalidation_cause = cause; + break; case RS_INVAL_NONE: pg_unreachable(); } @@ -1777,6 +1828,7 @@ InvalidatePossiblyObsoleteSlot(ReplicationSlotInvalidationCause cause, * - RS_INVAL_HORIZON: requires a snapshot <= the given horizon in the given * db; dboid may be InvalidOid for shared relations * - RS_INVAL_WAL_LEVEL: is logical + * - RS_INVAL_INACTIVE_TIMEOUT: inactive slot timeout occurs * * NB - this runs as part of checkpoint, so avoid raising errors if possible. */ @@ -1828,6 +1880,105 @@ restart: return invalidated; } +/* + * Invalidate given slot based on its inactive_timeout parameter. + * + * Returns true if the slot has got invalidated. + * + * NB - this function also runs as part of checkpoint, so avoid raising errors + * if possible. + */ +bool +InvalidateReplicationSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_locks, + bool persist_state) +{ + if (!InvalidateSlotForInactiveTimeout(slot, need_locks)) + return false; + + Assert(slot->active_pid == 0); + + SpinLockAcquire(&slot->mutex); + slot->data.invalidated = RS_INVAL_INACTIVE_TIMEOUT; + + /* Make sure the invalidated state persists across server restart */ + slot->just_dirtied = true; + slot->dirty = true; + SpinLockRelease(&slot->mutex); + + if (persist_state) + { + char path[MAXPGPATH]; + + sprintf(path, "pg_replslot/%s", NameStr(slot->data.name)); + SaveSlotToPath(slot, path, ERROR); + } + + ReportSlotInvalidation(RS_INVAL_INACTIVE_TIMEOUT, false, 0, + slot->data.name, InvalidXLogRecPtr, + InvalidXLogRecPtr, InvalidTransactionId); + + return true; +} + +/* + * Helper for InvalidateReplicationSlotForInactiveTimeout + */ +static bool +InvalidateSlotForInactiveTimeout(ReplicationSlot *slot, bool need_locks) +{ + ReplicationSlotInvalidationCause inavidation_cause = RS_INVAL_NONE; + + if (slot->inactive_since == 0 || + slot->data.inactive_timeout == 0) + return false; + + /* + * Do not invalidate the slots which are currently being synced from the + * primary to the standby. + */ + if (RecoveryInProgress() && slot->data.synced) + return false; + + if (need_locks) + { + LWLockAcquire(ReplicationSlotControlLock, LW_SHARED); + + /* + * Check if the slot needs to be invalidated due to inactive_timeout. + * We do this with the spinlock held to avoid race conditions -- for + * example the restart_lsn could move forward, or the slot could be + * dropped. + */ + + SpinLockAcquire(&slot->mutex); + } + + Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); + + if (slot->inactive_since > 0 && + slot->data.inactive_timeout > 0) + { + TimestampTz now; + + /* inactive_since is only tracked for inactive slots */ + Assert(slot->active_pid == 0); + + now = GetCurrentTimestamp(); + if (TimestampDifferenceExceeds(slot->inactive_since, now, + slot->data.inactive_timeout * 1000)) + inavidation_cause = RS_INVAL_INACTIVE_TIMEOUT; + } + + if (need_locks) + { + SpinLockRelease(&slot->mutex); + LWLockRelease(ReplicationSlotControlLock); + } + + return (inavidation_cause == RS_INVAL_INACTIVE_TIMEOUT); +} + /* * Flush all replication slots to disk. * @@ -1840,6 +1991,7 @@ void CheckPointReplicationSlots(bool is_shutdown) { int i; + bool invalidated = false; elog(DEBUG1, "performing replication slot checkpoint"); @@ -1863,6 +2015,13 @@ CheckPointReplicationSlots(bool is_shutdown) /* save the slot to disk, locking is handled in SaveSlotToPath() */ sprintf(path, "pg_replslot/%s", NameStr(s->data.name)); + /* + * Here's an opportunity to invalidate inactive replication slots + * based on timeout, so let's do it. + */ + if (InvalidateReplicationSlotForInactiveTimeout(s, true, false)) + invalidated = true; + /* * Slot's data is not flushed each time the confirmed_flush LSN is * updated as that could lead to frequent writes. However, we decide @@ -1889,6 +2048,13 @@ CheckPointReplicationSlots(bool is_shutdown) SaveSlotToPath(s, path, LOG); } LWLockRelease(ReplicationSlotAllocationLock); + + /* If the slot has been invalidated, recalculate the resource limits */ + if (invalidated) + { + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + } } /* diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c index 6e1d8d1f9a..4ea4db0f87 100644 --- a/src/backend/replication/slotfuncs.c +++ b/src/backend/replication/slotfuncs.c @@ -258,6 +258,7 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo; XLogRecPtr currlsn; int slotno; + bool invalidated = false; /* * We don't require any special permission to see this function's data @@ -466,6 +467,15 @@ pg_get_replication_slots(PG_FUNCTION_ARGS) LWLockRelease(ReplicationSlotControlLock); + /* + * If the slot has been invalidated, recalculate the resource limits + */ + if (invalidated) + { + ReplicationSlotsComputeRequiredXmin(false); + ReplicationSlotsComputeRequiredLSN(); + } + return (Datum) 0; } @@ -668,7 +678,7 @@ pg_replication_slot_advance(PG_FUNCTION_ARGS) moveto = Min(moveto, GetXLogReplayRecPtr(NULL)); /* Acquire the slot so we "own" it */ - ReplicationSlotAcquire(NameStr(*slotname), true); + ReplicationSlotAcquire(NameStr(*slotname), true, true); /* A slot whose restart_lsn has never been reserved cannot be advanced */ if (XLogRecPtrIsInvalid(MyReplicationSlot->data.restart_lsn)) diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c index 5315c08650..7dda2f5a66 100644 --- a/src/backend/replication/walsender.c +++ b/src/backend/replication/walsender.c @@ -846,7 +846,7 @@ StartReplication(StartReplicationCmd *cmd) if (cmd->slotname) { - ReplicationSlotAcquire(cmd->slotname, true); + ReplicationSlotAcquire(cmd->slotname, true, true); if (SlotIsLogical(MyReplicationSlot)) ereport(ERROR, (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), @@ -1459,7 +1459,7 @@ StartLogicalReplication(StartReplicationCmd *cmd) Assert(!MyReplicationSlot); - ReplicationSlotAcquire(cmd->slotname, true); + ReplicationSlotAcquire(cmd->slotname, true, true); /* * Force a disconnect, so that the decoding code doesn't need to care diff --git a/src/backend/utils/adt/pg_upgrade_support.c b/src/backend/utils/adt/pg_upgrade_support.c index c54b08fe18..82956d58d3 100644 --- a/src/backend/utils/adt/pg_upgrade_support.c +++ b/src/backend/utils/adt/pg_upgrade_support.c @@ -299,7 +299,7 @@ binary_upgrade_logical_slot_has_caught_up(PG_FUNCTION_ARGS) slot_name = PG_GETARG_NAME(0); /* Acquire the given slot */ - ReplicationSlotAcquire(NameStr(*slot_name), true); + ReplicationSlotAcquire(NameStr(*slot_name), true, false); Assert(SlotIsLogical(MyReplicationSlot)); diff --git a/src/bin/pg_upgrade/pg_upgrade.h b/src/bin/pg_upgrade/pg_upgrade.h index eb86d000b1..38d105c5d6 100644 --- a/src/bin/pg_upgrade/pg_upgrade.h +++ b/src/bin/pg_upgrade/pg_upgrade.h @@ -163,7 +163,8 @@ typedef struct bool failover; /* is the slot designated to be synced to the * physical standby? */ int inactive_timeout; /* The amount of time in seconds the slot - * is allowed to be inactive. */ + * is allowed to be inactive before + * getting invalidated. */ } LogicalSlotInfo; typedef struct diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h index 5a812ef528..75b0bad083 100644 --- a/src/include/replication/slot.h +++ b/src/include/replication/slot.h @@ -53,6 +53,8 @@ typedef enum ReplicationSlotInvalidationCause RS_INVAL_HORIZON, /* wal_level insufficient for slot */ RS_INVAL_WAL_LEVEL, + /* inactive slot timeout has occurred */ + RS_INVAL_INACTIVE_TIMEOUT, } ReplicationSlotInvalidationCause; extern PGDLLIMPORT const char *const SlotInvalidationCauses[]; @@ -248,7 +250,8 @@ extern void ReplicationSlotDrop(const char *name, bool nowait); extern void ReplicationSlotDropAcquired(void); extern void ReplicationSlotAlter(const char *name, bool failover); -extern void ReplicationSlotAcquire(const char *name, bool nowait); +extern void ReplicationSlotAcquire(const char *name, bool nowait, + bool check_for_invalidation); extern void ReplicationSlotRelease(void); extern void ReplicationSlotCleanup(void); extern void ReplicationSlotSave(void); @@ -267,6 +270,9 @@ extern bool InvalidateObsoleteReplicationSlots(ReplicationSlotInvalidationCause XLogSegNo oldestSegno, Oid dboid, TransactionId snapshotConflictHorizon); +extern bool InvalidateReplicationSlotForInactiveTimeout(ReplicationSlot *slot, + bool need_locks, + bool persist_state); extern ReplicationSlot *SearchNamedReplicationSlot(const char *name, bool need_lock); extern int ReplicationSlotIndex(ReplicationSlot *slot); extern bool ReplicationSlotName(int index, Name name); diff --git a/src/test/recovery/meson.build b/src/test/recovery/meson.build index b1eb77b1ec..708a2a3798 100644 --- a/src/test/recovery/meson.build +++ b/src/test/recovery/meson.build @@ -51,6 +51,7 @@ tests += { 't/040_standby_failover_slots_sync.pl', 't/041_checkpoint_at_promote.pl', 't/042_low_level_backup.pl', + 't/050_invalidate_slots.pl', ], }, } diff --git a/src/test/recovery/t/050_invalidate_slots.pl b/src/test/recovery/t/050_invalidate_slots.pl new file mode 100644 index 0000000000..b906d240a5 --- /dev/null +++ b/src/test/recovery/t/050_invalidate_slots.pl @@ -0,0 +1,169 @@ +# Copyright (c) 2024, PostgreSQL Global Development Group + +# Test for replication slots invalidation +use strict; +use warnings FATAL => 'all'; + +use PostgreSQL::Test::Utils; +use PostgreSQL::Test::Cluster; +use Test::More; +use Time::HiRes qw(usleep); + +# Check for invalidation of slot in server log. +sub check_slots_invalidation_in_server_log +{ + my ($node, $slot_name, $offset) = @_; + my $invalidated = 0; + + for (my $i = 0; $i < 10 * $PostgreSQL::Test::Utils::timeout_default; $i++) + { + $node->safe_psql('postgres', "CHECKPOINT"); + if ($node->log_contains( + "invalidating obsolete replication slot \"$slot_name\"", $offset)) + { + $invalidated = 1; + last; + } + usleep(100_000); + } + ok($invalidated, "check that slot $slot_name invalidation has been logged"); +} + +# ============================================================================= +# Testcase start: Invalidate streaming standby's slot due to inactive_timeout +# + +# Initialize primary node +my $primary = PostgreSQL::Test::Cluster->new('primary'); +$primary->init(allows_streaming => 'logical'); + +# Avoid checkpoint during the test, otherwise, the test can get unpredictable +$primary->append_conf( + 'postgresql.conf', q{ +checkpoint_timeout = 1h +autovacuum = off +}); +$primary->start; + +# Take backup +my $backup_name = 'my_backup'; +$primary->backup($backup_name); + +# Create a standby linking to the primary using the replication slot +my $standby1 = PostgreSQL::Test::Cluster->new('standby1'); +$standby1->init_from_backup($primary, $backup_name, has_streaming => 1); +$standby1->append_conf( + 'postgresql.conf', q{ +primary_slot_name = 'sb1_slot' +}); + +# Set timeout so that the slot when inactive will get invalidated after the +# timeout. +my $inactive_timeout = 5; +$primary->safe_psql( + 'postgres', qq[ + SELECT pg_create_physical_replication_slot(slot_name := 'sb1_slot', inactive_timeout := $inactive_timeout); +]); + +$standby1->start; + +# Wait until standby has replayed enough data +$primary->wait_for_catchup($standby1); + +# Check inactive_timeout is what we've set above +my $result = $primary->safe_psql( + 'postgres', qq[ + SELECT inactive_timeout = $inactive_timeout + FROM pg_replication_slots WHERE slot_name = 'sb1_slot'; +]); +is($result, "t", + 'check the inactive replication slot info for an active slot'); + +my $logstart = -s $primary->logfile; + +# Stop standby to make the replication slot on primary inactive +$standby1->stop; + +# Wait for the inactive replication slot info to be updated +$primary->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE inactive_since IS NOT NULL + AND slot_name = 'sb1_slot' + AND inactive_timeout = $inactive_timeout; +]) + or die + "Timed out while waiting for inactive replication slot info to be updated"; + +check_slots_invalidation_in_server_log($primary, 'sb1_slot', $logstart); + +# Wait for the inactive replication slots to be invalidated. +$primary->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE slot_name = 'sb1_slot' AND + invalidation_reason = 'inactive_timeout'; +]) + or die + "Timed out while waiting for inactive replication slot sb1_slot to be invalidated"; + +# Testcase end: Invalidate streaming standby's slot due to inactive_timeout +# ============================================================================= + +# ============================================================================= +# Testcase start: Invalidate logical subscriber's slot due to inactive_timeout +my $publisher = $primary; + +# Create subscriber node +my $subscriber = PostgreSQL::Test::Cluster->new('sub'); +$subscriber->init; +$subscriber->start; + +# Create tables +$publisher->safe_psql('postgres', "CREATE TABLE test_tbl (id int)"); +$subscriber->safe_psql('postgres', "CREATE TABLE test_tbl (id int)"); + +# Insert some data +$subscriber->safe_psql('postgres', + "INSERT INTO test_tbl VALUES (generate_series(1, 5));"); + +# Setup logical replication +my $publisher_connstr = $publisher->connstr . ' dbname=postgres'; +$publisher->safe_psql('postgres', "CREATE PUBLICATION pub FOR ALL TABLES"); +$publisher->safe_psql( + 'postgres', qq[ + SELECT pg_create_logical_replication_slot(slot_name := 'lsub1_slot', plugin := 'pgoutput', inactive_timeout := $inactive_timeout); +]); + +$subscriber->safe_psql('postgres', + "CREATE SUBSCRIPTION sub CONNECTION '$publisher_connstr' PUBLICATION pub WITH (slot_name = 'lsub1_slot', create_slot = false)" +); + +$subscriber->wait_for_subscription_sync($publisher, 'sub'); + +$result = $subscriber->safe_psql('postgres', "SELECT count(*) FROM test_tbl"); + +is($result, qq(5), "check initial copy was done"); + +$logstart = -s $publisher->logfile; + +# Stop subscriber to make the replication slot on publisher inactive +$subscriber->stop; + +# Wait for the inactive replication slot info to be updated +$publisher->poll_query_until( + 'postgres', qq[ + SELECT COUNT(slot_name) = 1 FROM pg_replication_slots + WHERE inactive_since IS NOT NULL + AND slot_name = 'lsub1_slot' + AND inactive_timeout = $inactive_timeout; +]) + or die + "Timed out while waiting for inactive replication slot info to be updated"; + +check_slots_invalidation_in_server_log($publisher, 'lsub1_slot', $logstart); + +# Testcase end: Invalidate logical subscriber's slot due to inactive_timeout +# ============================================================================= + +done_testing(); -- 2.34.1 ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 09:22 shveta malik <[email protected]> parent: Bharath Rupireddy <[email protected]> 2 siblings, 0 replies; 43+ messages in thread From: shveta malik @ 2024-03-26 09:22 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]>; shveta malik <[email protected]> On Tue, Mar 26, 2024 at 2:27 PM Bharath Rupireddy <[email protected]> wrote: > > > > > 1) > > Commti msg: > > > > ensures the value is set to current timestamp during the > > shutdown to help correctly interpret the time if the standby gets > > promoted without a restart. > > > > shutdown --> shutdown of slot sync worker (as it was not clear if it > > is instance shutdown or something else) > > Changed it to "shutdown of slot sync machinery" to be consistent with > the comments. Thanks for addressing the comments. Just to give more clarity here (so that you take a informed decision), I am not sure if we actually shut down slot-sync machinery. We only shot down slot sync worker. Slot-sync machinery can still be used using 'pg_sync_replication_slots' SQL function. I can easily reproduce the scenario where SQL function and reset_synced_slots_info() are going in parallel where the latter hits 'Assert(s->active_pid == 0)' due to the fact that parallel SQL sync function is active on that slot. thanks Shveta ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 09:42 Bertrand Drouvot <[email protected]> parent: Bharath Rupireddy <[email protected]> 2 siblings, 1 reply; 43+ messages in thread From: Bertrand Drouvot @ 2024-03-26 09:42 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> Hi, On Tue, Mar 26, 2024 at 02:27:17PM +0530, Bharath Rupireddy wrote: > Please use the v22 patch set. Thanks! 1 === +reset_synced_slots_info(void) I'm not sure "reset" is the right word, what about slot_sync_shutdown_update()? 2 === + for (int i = 0; i < max_replication_slots; i++) + { + ReplicationSlot *s = &ReplicationSlotCtl->replication_slots[i]; + + /* Check if it is a synchronized slot */ + if (s->in_use && s->data.synced) + { + TimestampTz now; + + Assert(SlotIsLogical(s)); + Assert(s->active_pid == 0); + + /* + * Set the time since the slot has become inactive after shutting + * down slot sync machinery. This helps correctly interpret the + * time if the standby gets promoted without a restart. We get the + * current time beforehand to avoid a system call while holding + * the lock. + */ + now = GetCurrentTimestamp(); What about moving "now = GetCurrentTimestamp()" outside of the for loop? (it would be less costly and probably good enough). Regards, -- Bertrand Drouvot PostgreSQL Contributors Team RDS Open Source Databases Amazon Web Services: https://aws.amazon.com ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 10:21 Amit Kapila <[email protected]> parent: Bertrand Drouvot <[email protected]> 0 siblings, 0 replies; 43+ messages in thread From: Amit Kapila @ 2024-03-26 10:21 UTC (permalink / raw) To: Bertrand Drouvot <[email protected]>; +Cc: Bharath Rupireddy <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Tue, Mar 26, 2024 at 3:12 PM Bertrand Drouvot <[email protected]> wrote: > > On Tue, Mar 26, 2024 at 02:27:17PM +0530, Bharath Rupireddy wrote: > > Please use the v22 patch set. > > Thanks! > > 1 === > > +reset_synced_slots_info(void) > > I'm not sure "reset" is the right word, what about slot_sync_shutdown_update()? > *shutdown_update() sounds generic. How about update_synced_slots_inactive_time()? I think it is a bit longer but conveys the meaning. -- With Regards, Amit Kapila. ^ permalink raw reply [nested|flat] 43+ messages in thread
* Re: Introduce XID age and inactive timeout based replication slot invalidation @ 2024-03-26 10:22 Ajin Cherian <[email protected]> parent: Bharath Rupireddy <[email protected]> 2 siblings, 0 replies; 43+ messages in thread From: Ajin Cherian @ 2024-03-26 10:22 UTC (permalink / raw) To: Bharath Rupireddy <[email protected]>; +Cc: Amit Kapila <[email protected]>; Bertrand Drouvot <[email protected]>; Nathan Bossart <[email protected]>; PostgreSQL Hackers <[email protected]> On Tue, Mar 26, 2024 at 7:57 PM Bharath Rupireddy < [email protected]> wrote: > Please see the attached v23 patches. I've addressed all the review > comments received so far from Amit and Shveta. > > In patch 0003: + SpinLockAcquire(&slot->mutex); + } + + Assert(LWLockHeldByMeInMode(ReplicationSlotControlLock, LW_SHARED)); + + if (slot->inactive_since > 0 && + slot->data.inactive_timeout > 0) + { + TimestampTz now; + + /* inactive_since is only tracked for inactive slots */ + Assert(slot->active_pid == 0); + + now = GetCurrentTimestamp(); + if (TimestampDifferenceExceeds(slot->inactive_since, now, + slot->data.inactive_timeout * 1000)) + inavidation_cause = RS_INVAL_INACTIVE_TIMEOUT; + } + + if (need_locks) + { + SpinLockRelease(&slot->mutex); Here, GetCurrentTimestamp() is still called with SpinLock held. Maybe do this prior to acquiring the spinlock. regards, Ajin Cherian Fujitsu Australia ^ permalink raw reply [nested|flat] 43+ messages in thread
* [PATCH v21 7/8] Row pattern recognition patch (tests). @ 2024-08-26 04:32 Tatsuo Ishii <[email protected]> 0 siblings, 0 replies; 43+ messages in thread From: Tatsuo Ishii @ 2024-08-26 04:32 UTC (permalink / raw) --- src/test/regress/expected/rpr.out | 836 +++++++++++++++++++++++++++++ src/test/regress/parallel_schedule | 2 +- src/test/regress/sql/rpr.sql | 405 ++++++++++++++ 3 files changed, 1242 insertions(+), 1 deletion(-) create mode 100644 src/test/regress/expected/rpr.out create mode 100644 src/test/regress/sql/rpr.sql diff --git a/src/test/regress/expected/rpr.out b/src/test/regress/expected/rpr.out new file mode 100644 index 0000000000..0789e09435 --- /dev/null +++ b/src/test/regress/expected/rpr.out @@ -0,0 +1,836 @@ +-- +-- Test for row pattern definition clause +-- +CREATE TEMP TABLE stock ( + company TEXT, + tdate DATE, + price INTEGER +); +INSERT INTO stock VALUES ('company1', '2023-07-01', 100); +INSERT INTO stock VALUES ('company1', '2023-07-02', 200); +INSERT INTO stock VALUES ('company1', '2023-07-03', 150); +INSERT INTO stock VALUES ('company1', '2023-07-04', 140); +INSERT INTO stock VALUES ('company1', '2023-07-05', 150); +INSERT INTO stock VALUES ('company1', '2023-07-06', 90); +INSERT INTO stock VALUES ('company1', '2023-07-07', 110); +INSERT INTO stock VALUES ('company1', '2023-07-08', 130); +INSERT INTO stock VALUES ('company1', '2023-07-09', 120); +INSERT INTO stock VALUES ('company1', '2023-07-10', 130); +INSERT INTO stock VALUES ('company2', '2023-07-01', 50); +INSERT INTO stock VALUES ('company2', '2023-07-02', 2000); +INSERT INTO stock VALUES ('company2', '2023-07-03', 1500); +INSERT INTO stock VALUES ('company2', '2023-07-04', 1400); +INSERT INTO stock VALUES ('company2', '2023-07-05', 1500); +INSERT INTO stock VALUES ('company2', '2023-07-06', 60); +INSERT INTO stock VALUES ('company2', '2023-07-07', 1100); +INSERT INTO stock VALUES ('company2', '2023-07-08', 1300); +INSERT INTO stock VALUES ('company2', '2023-07-09', 1200); +INSERT INTO stock VALUES ('company2', '2023-07-10', 1300); +SELECT * FROM stock; + company | tdate | price +----------+------------+------- + company1 | 07-01-2023 | 100 + company1 | 07-02-2023 | 200 + company1 | 07-03-2023 | 150 + company1 | 07-04-2023 | 140 + company1 | 07-05-2023 | 150 + company1 | 07-06-2023 | 90 + company1 | 07-07-2023 | 110 + company1 | 07-08-2023 | 130 + company1 | 07-09-2023 | 120 + company1 | 07-10-2023 | 130 + company2 | 07-01-2023 | 50 + company2 | 07-02-2023 | 2000 + company2 | 07-03-2023 | 1500 + company2 | 07-04-2023 | 1400 + company2 | 07-05-2023 | 1500 + company2 | 07-06-2023 | 60 + company2 | 07-07-2023 | 1100 + company2 | 07-08-2023 | 1300 + company2 | 07-09-2023 | 1200 + company2 | 07-10-2023 | 1300 +(20 rows) + +-- basic test using PREV +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value | nth_second +----------+------------+-------+-------------+------------+------------ + company1 | 07-01-2023 | 100 | 100 | 140 | 07-02-2023 + company1 | 07-02-2023 | 200 | | | + company1 | 07-03-2023 | 150 | | | + company1 | 07-04-2023 | 140 | | | + company1 | 07-05-2023 | 150 | | | + company1 | 07-06-2023 | 90 | 90 | 120 | 07-07-2023 + company1 | 07-07-2023 | 110 | | | + company1 | 07-08-2023 | 130 | | | + company1 | 07-09-2023 | 120 | | | + company1 | 07-10-2023 | 130 | | | + company2 | 07-01-2023 | 50 | 50 | 1400 | 07-02-2023 + company2 | 07-02-2023 | 2000 | | | + company2 | 07-03-2023 | 1500 | | | + company2 | 07-04-2023 | 1400 | | | + company2 | 07-05-2023 | 1500 | | | + company2 | 07-06-2023 | 60 | 60 | 1200 | 07-07-2023 + company2 | 07-07-2023 | 1100 | | | + company2 | 07-08-2023 | 1300 | | | + company2 | 07-09-2023 | 1200 | | | + company2 | 07-10-2023 | 1300 | | | +(20 rows) + +-- basic test using PREV. UP appears twice +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+ UP+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value | nth_second +----------+------------+-------+-------------+------------+------------ + company1 | 07-01-2023 | 100 | 100 | 150 | 07-02-2023 + company1 | 07-02-2023 | 200 | | | + company1 | 07-03-2023 | 150 | | | + company1 | 07-04-2023 | 140 | | | + company1 | 07-05-2023 | 150 | | | + company1 | 07-06-2023 | 90 | 90 | 130 | 07-07-2023 + company1 | 07-07-2023 | 110 | | | + company1 | 07-08-2023 | 130 | | | + company1 | 07-09-2023 | 120 | | | + company1 | 07-10-2023 | 130 | | | + company2 | 07-01-2023 | 50 | 50 | 1500 | 07-02-2023 + company2 | 07-02-2023 | 2000 | | | + company2 | 07-03-2023 | 1500 | | | + company2 | 07-04-2023 | 1400 | | | + company2 | 07-05-2023 | 1500 | | | + company2 | 07-06-2023 | 60 | 60 | 1300 | 07-07-2023 + company2 | 07-07-2023 | 1100 | | | + company2 | 07-08-2023 | 1300 | | | + company2 | 07-09-2023 | 1200 | | | + company2 | 07-10-2023 | 1300 | | | +(20 rows) + +-- basic test using PREV. Use '*' +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP* DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value | nth_second +----------+------------+-------+-------------+------------+------------ + company1 | 07-01-2023 | 100 | 100 | 140 | 07-02-2023 + company1 | 07-02-2023 | 200 | | | + company1 | 07-03-2023 | 150 | | | + company1 | 07-04-2023 | 140 | | | + company1 | 07-05-2023 | 150 | 150 | 90 | 07-06-2023 + company1 | 07-06-2023 | 90 | | | + company1 | 07-07-2023 | 110 | 110 | 120 | 07-08-2023 + company1 | 07-08-2023 | 130 | | | + company1 | 07-09-2023 | 120 | | | + company1 | 07-10-2023 | 130 | | | + company2 | 07-01-2023 | 50 | 50 | 1400 | 07-02-2023 + company2 | 07-02-2023 | 2000 | | | + company2 | 07-03-2023 | 1500 | | | + company2 | 07-04-2023 | 1400 | | | + company2 | 07-05-2023 | 1500 | 1500 | 60 | 07-06-2023 + company2 | 07-06-2023 | 60 | | | + company2 | 07-07-2023 | 1100 | 1100 | 1200 | 07-08-2023 + company2 | 07-08-2023 | 1300 | | | + company2 | 07-09-2023 | 1200 | | | + company2 | 07-10-2023 | 1300 | | | +(20 rows) + +-- basic test with none greedy pattern +SELECT company, tdate, price, count(*) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (A A A) + DEFINE + A AS price >= 140 AND price <= 150 +); + company | tdate | price | count +----------+------------+-------+------- + company1 | 07-01-2023 | 100 | 0 + company1 | 07-02-2023 | 200 | 0 + company1 | 07-03-2023 | 150 | 3 + company1 | 07-04-2023 | 140 | 0 + company1 | 07-05-2023 | 150 | 0 + company1 | 07-06-2023 | 90 | 0 + company1 | 07-07-2023 | 110 | 0 + company1 | 07-08-2023 | 130 | 0 + company1 | 07-09-2023 | 120 | 0 + company1 | 07-10-2023 | 130 | 0 + company2 | 07-01-2023 | 50 | 0 + company2 | 07-02-2023 | 2000 | 0 + company2 | 07-03-2023 | 1500 | 0 + company2 | 07-04-2023 | 1400 | 0 + company2 | 07-05-2023 | 1500 | 0 + company2 | 07-06-2023 | 60 | 0 + company2 | 07-07-2023 | 1100 | 0 + company2 | 07-08-2023 | 1300 | 0 + company2 | 07-09-2023 | 1200 | 0 + company2 | 07-10-2023 | 1300 | 0 +(20 rows) + +-- last_value() should remain consistent +SELECT company, tdate, price, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + company | tdate | price | last_value +----------+------------+-------+------------ + company1 | 07-01-2023 | 100 | 140 + company1 | 07-02-2023 | 200 | + company1 | 07-03-2023 | 150 | + company1 | 07-04-2023 | 140 | + company1 | 07-05-2023 | 150 | + company1 | 07-06-2023 | 90 | 120 + company1 | 07-07-2023 | 110 | + company1 | 07-08-2023 | 130 | + company1 | 07-09-2023 | 120 | + company1 | 07-10-2023 | 130 | + company2 | 07-01-2023 | 50 | 1400 + company2 | 07-02-2023 | 2000 | + company2 | 07-03-2023 | 1500 | + company2 | 07-04-2023 | 1400 | + company2 | 07-05-2023 | 1500 | + company2 | 07-06-2023 | 60 | 1200 + company2 | 07-07-2023 | 1100 | + company2 | 07-08-2023 | 1300 | + company2 | 07-09-2023 | 1200 | + company2 | 07-10-2023 | 1300 | +(20 rows) + +-- omit "START" in DEFINE but it is ok because "START AS TRUE" is +-- implicitly defined. per spec. +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value | nth_second +----------+------------+-------+-------------+------------+------------ + company1 | 07-01-2023 | 100 | 100 | 140 | 07-02-2023 + company1 | 07-02-2023 | 200 | | | + company1 | 07-03-2023 | 150 | | | + company1 | 07-04-2023 | 140 | | | + company1 | 07-05-2023 | 150 | | | + company1 | 07-06-2023 | 90 | 90 | 120 | 07-07-2023 + company1 | 07-07-2023 | 110 | | | + company1 | 07-08-2023 | 130 | | | + company1 | 07-09-2023 | 120 | | | + company1 | 07-10-2023 | 130 | | | + company2 | 07-01-2023 | 50 | 50 | 1400 | 07-02-2023 + company2 | 07-02-2023 | 2000 | | | + company2 | 07-03-2023 | 1500 | | | + company2 | 07-04-2023 | 1400 | | | + company2 | 07-05-2023 | 1500 | | | + company2 | 07-06-2023 | 60 | 60 | 1200 | 07-07-2023 + company2 | 07-07-2023 | 1100 | | | + company2 | 07-08-2023 | 1300 | | | + company2 | 07-09-2023 | 1200 | | | + company2 | 07-10-2023 | 1300 | | | +(20 rows) + +-- the first row start with less than or equal to 100 +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (LOWPRICE UP+ DOWN+) + DEFINE + LOWPRICE AS price <= 100, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value +----------+------------+-------+-------------+------------ + company1 | 07-01-2023 | 100 | 100 | 140 + company1 | 07-02-2023 | 200 | | + company1 | 07-03-2023 | 150 | | + company1 | 07-04-2023 | 140 | | + company1 | 07-05-2023 | 150 | | + company1 | 07-06-2023 | 90 | 90 | 120 + company1 | 07-07-2023 | 110 | | + company1 | 07-08-2023 | 130 | | + company1 | 07-09-2023 | 120 | | + company1 | 07-10-2023 | 130 | | + company2 | 07-01-2023 | 50 | 50 | 1400 + company2 | 07-02-2023 | 2000 | | + company2 | 07-03-2023 | 1500 | | + company2 | 07-04-2023 | 1400 | | + company2 | 07-05-2023 | 1500 | | + company2 | 07-06-2023 | 60 | 60 | 1200 + company2 | 07-07-2023 | 1100 | | + company2 | 07-08-2023 | 1300 | | + company2 | 07-09-2023 | 1200 | | + company2 | 07-10-2023 | 1300 | | +(20 rows) + +-- second row raises 120% +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (LOWPRICE UP+ DOWN+) + DEFINE + LOWPRICE AS price <= 100, + UP AS price > PREV(price) * 1.2, + DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value +----------+------------+-------+-------------+------------ + company1 | 07-01-2023 | 100 | 100 | 140 + company1 | 07-02-2023 | 200 | | + company1 | 07-03-2023 | 150 | | + company1 | 07-04-2023 | 140 | | + company1 | 07-05-2023 | 150 | | + company1 | 07-06-2023 | 90 | | + company1 | 07-07-2023 | 110 | | + company1 | 07-08-2023 | 130 | | + company1 | 07-09-2023 | 120 | | + company1 | 07-10-2023 | 130 | | + company2 | 07-01-2023 | 50 | 50 | 1400 + company2 | 07-02-2023 | 2000 | | + company2 | 07-03-2023 | 1500 | | + company2 | 07-04-2023 | 1400 | | + company2 | 07-05-2023 | 1500 | | + company2 | 07-06-2023 | 60 | | + company2 | 07-07-2023 | 1100 | | + company2 | 07-08-2023 | 1300 | | + company2 | 07-09-2023 | 1200 | | + company2 | 07-10-2023 | 1300 | | +(20 rows) + +-- using NEXT +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UPDOWN) + DEFINE + START AS TRUE, + UPDOWN AS price > PREV(price) AND price > NEXT(price) +); + company | tdate | price | first_value | last_value +----------+------------+-------+-------------+------------ + company1 | 07-01-2023 | 100 | 100 | 200 + company1 | 07-02-2023 | 200 | | + company1 | 07-03-2023 | 150 | | + company1 | 07-04-2023 | 140 | 140 | 150 + company1 | 07-05-2023 | 150 | | + company1 | 07-06-2023 | 90 | | + company1 | 07-07-2023 | 110 | 110 | 130 + company1 | 07-08-2023 | 130 | | + company1 | 07-09-2023 | 120 | | + company1 | 07-10-2023 | 130 | | + company2 | 07-01-2023 | 50 | 50 | 2000 + company2 | 07-02-2023 | 2000 | | + company2 | 07-03-2023 | 1500 | | + company2 | 07-04-2023 | 1400 | 1400 | 1500 + company2 | 07-05-2023 | 1500 | | + company2 | 07-06-2023 | 60 | | + company2 | 07-07-2023 | 1100 | 1100 | 1300 + company2 | 07-08-2023 | 1300 | | + company2 | 07-09-2023 | 1200 | | + company2 | 07-10-2023 | 1300 | | +(20 rows) + +-- using AFTER MATCH SKIP TO NEXT ROW +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP TO NEXT ROW + INITIAL + PATTERN (START UPDOWN) + DEFINE + START AS TRUE, + UPDOWN AS price > PREV(price) AND price > NEXT(price) +); + company | tdate | price | first_value | last_value +----------+------------+-------+-------------+------------ + company1 | 07-01-2023 | 100 | 100 | 200 + company1 | 07-02-2023 | 200 | | + company1 | 07-03-2023 | 150 | | + company1 | 07-04-2023 | 140 | 140 | 150 + company1 | 07-05-2023 | 150 | | + company1 | 07-06-2023 | 90 | | + company1 | 07-07-2023 | 110 | 110 | 130 + company1 | 07-08-2023 | 130 | | + company1 | 07-09-2023 | 120 | | + company1 | 07-10-2023 | 130 | | + company2 | 07-01-2023 | 50 | 50 | 2000 + company2 | 07-02-2023 | 2000 | | + company2 | 07-03-2023 | 1500 | | + company2 | 07-04-2023 | 1400 | 1400 | 1500 + company2 | 07-05-2023 | 1500 | | + company2 | 07-06-2023 | 60 | | + company2 | 07-07-2023 | 1100 | 1100 | 1300 + company2 | 07-08-2023 | 1300 | | + company2 | 07-09-2023 | 1200 | | + company2 | 07-10-2023 | 1300 | | +(20 rows) + +-- match everything +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP PAST LAST ROW + INITIAL + PATTERN (A+) + DEFINE + A AS TRUE +); + company | tdate | price | first_value | last_value +----------+------------+-------+-------------+------------ + company1 | 07-01-2023 | 100 | 100 | 130 + company1 | 07-02-2023 | 200 | | + company1 | 07-03-2023 | 150 | | + company1 | 07-04-2023 | 140 | | + company1 | 07-05-2023 | 150 | | + company1 | 07-06-2023 | 90 | | + company1 | 07-07-2023 | 110 | | + company1 | 07-08-2023 | 130 | | + company1 | 07-09-2023 | 120 | | + company1 | 07-10-2023 | 130 | | + company2 | 07-01-2023 | 50 | 50 | 1300 + company2 | 07-02-2023 | 2000 | | + company2 | 07-03-2023 | 1500 | | + company2 | 07-04-2023 | 1400 | | + company2 | 07-05-2023 | 1500 | | + company2 | 07-06-2023 | 60 | | + company2 | 07-07-2023 | 1100 | | + company2 | 07-08-2023 | 1300 | | + company2 | 07-09-2023 | 1200 | | + company2 | 07-10-2023 | 1300 | | +(20 rows) + +-- backtracking with reclassification of rows +-- using AFTER MATCH SKIP PAST LAST ROW +SELECT company, tdate, price, first_value(tdate) OVER w, last_value(tdate) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP PAST LAST ROW + INITIAL + PATTERN (A+ B+) + DEFINE + A AS price > 100, + B AS price > 100 +); + company | tdate | price | first_value | last_value +----------+------------+-------+-------------+------------ + company1 | 07-01-2023 | 100 | | + company1 | 07-02-2023 | 200 | 07-02-2023 | 07-05-2023 + company1 | 07-03-2023 | 150 | | + company1 | 07-04-2023 | 140 | | + company1 | 07-05-2023 | 150 | | + company1 | 07-06-2023 | 90 | | + company1 | 07-07-2023 | 110 | 07-07-2023 | 07-10-2023 + company1 | 07-08-2023 | 130 | | + company1 | 07-09-2023 | 120 | | + company1 | 07-10-2023 | 130 | | + company2 | 07-01-2023 | 50 | | + company2 | 07-02-2023 | 2000 | 07-02-2023 | 07-05-2023 + company2 | 07-03-2023 | 1500 | | + company2 | 07-04-2023 | 1400 | | + company2 | 07-05-2023 | 1500 | | + company2 | 07-06-2023 | 60 | | + company2 | 07-07-2023 | 1100 | 07-07-2023 | 07-10-2023 + company2 | 07-08-2023 | 1300 | | + company2 | 07-09-2023 | 1200 | | + company2 | 07-10-2023 | 1300 | | +(20 rows) + +-- backtracking with reclassification of rows +-- using AFTER MATCH SKIP TO NEXT ROW +SELECT company, tdate, price, first_value(tdate) OVER w, last_value(tdate) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP TO NEXT ROW + INITIAL + PATTERN (A+ B+) + DEFINE + A AS price > 100, + B AS price > 100 +); + company | tdate | price | first_value | last_value +----------+------------+-------+-------------+------------ + company1 | 07-01-2023 | 100 | | + company1 | 07-02-2023 | 200 | 07-02-2023 | 07-05-2023 + company1 | 07-03-2023 | 150 | 07-03-2023 | 07-05-2023 + company1 | 07-04-2023 | 140 | 07-04-2023 | 07-05-2023 + company1 | 07-05-2023 | 150 | | + company1 | 07-06-2023 | 90 | | + company1 | 07-07-2023 | 110 | 07-07-2023 | 07-10-2023 + company1 | 07-08-2023 | 130 | 07-08-2023 | 07-10-2023 + company1 | 07-09-2023 | 120 | 07-09-2023 | 07-10-2023 + company1 | 07-10-2023 | 130 | | + company2 | 07-01-2023 | 50 | | + company2 | 07-02-2023 | 2000 | 07-02-2023 | 07-05-2023 + company2 | 07-03-2023 | 1500 | 07-03-2023 | 07-05-2023 + company2 | 07-04-2023 | 1400 | 07-04-2023 | 07-05-2023 + company2 | 07-05-2023 | 1500 | | + company2 | 07-06-2023 | 60 | | + company2 | 07-07-2023 | 1100 | 07-07-2023 | 07-10-2023 + company2 | 07-08-2023 | 1300 | 07-08-2023 | 07-10-2023 + company2 | 07-09-2023 | 1200 | 07-09-2023 | 07-10-2023 + company2 | 07-10-2023 | 1300 | | +(20 rows) + +-- ROWS BETWEEN CURRENT ROW AND offset FOLLOWING +SELECT company, tdate, price, first_value(tdate) OVER w, last_value(tdate) OVER w, + count(*) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND 2 FOLLOWING + AFTER MATCH SKIP PAST LAST ROW + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value | count +----------+------------+-------+-------------+------------+------- + company1 | 07-01-2023 | 100 | 07-01-2023 | 07-03-2023 | 3 + company1 | 07-02-2023 | 200 | | | 0 + company1 | 07-03-2023 | 150 | | | 0 + company1 | 07-04-2023 | 140 | 07-04-2023 | 07-06-2023 | 3 + company1 | 07-05-2023 | 150 | | | 0 + company1 | 07-06-2023 | 90 | | | 0 + company1 | 07-07-2023 | 110 | 07-07-2023 | 07-09-2023 | 3 + company1 | 07-08-2023 | 130 | | | 0 + company1 | 07-09-2023 | 120 | | | 0 + company1 | 07-10-2023 | 130 | | | 0 + company2 | 07-01-2023 | 50 | 07-01-2023 | 07-03-2023 | 3 + company2 | 07-02-2023 | 2000 | | | 0 + company2 | 07-03-2023 | 1500 | | | 0 + company2 | 07-04-2023 | 1400 | 07-04-2023 | 07-06-2023 | 3 + company2 | 07-05-2023 | 1500 | | | 0 + company2 | 07-06-2023 | 60 | | | 0 + company2 | 07-07-2023 | 1100 | 07-07-2023 | 07-09-2023 | 3 + company2 | 07-08-2023 | 1300 | | | 0 + company2 | 07-09-2023 | 1200 | | | 0 + company2 | 07-10-2023 | 1300 | | | 0 +(20 rows) + +-- +-- Aggregates +-- +-- using AFTER MATCH SKIP PAST LAST ROW +SELECT company, tdate, price, + first_value(price) OVER w, + last_value(price) OVER w, + max(price) OVER w, + min(price) OVER w, + sum(price) OVER w, + avg(price) OVER w, + count(price) OVER w +FROM stock +WINDOW w AS ( +PARTITION BY company +ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING +AFTER MATCH SKIP PAST LAST ROW +INITIAL +PATTERN (START UP+ DOWN+) +DEFINE +START AS TRUE, +UP AS price > PREV(price), +DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value | max | min | sum | avg | count +----------+------------+-------+-------------+------------+------+-----+------+-----------------------+------- + company1 | 07-01-2023 | 100 | 100 | 140 | 200 | 100 | 590 | 147.5000000000000000 | 4 + company1 | 07-02-2023 | 200 | | | | | | | 0 + company1 | 07-03-2023 | 150 | | | | | | | 0 + company1 | 07-04-2023 | 140 | | | | | | | 0 + company1 | 07-05-2023 | 150 | | | | | | | 0 + company1 | 07-06-2023 | 90 | 90 | 120 | 130 | 90 | 450 | 112.5000000000000000 | 4 + company1 | 07-07-2023 | 110 | | | | | | | 0 + company1 | 07-08-2023 | 130 | | | | | | | 0 + company1 | 07-09-2023 | 120 | | | | | | | 0 + company1 | 07-10-2023 | 130 | | | | | | | 0 + company2 | 07-01-2023 | 50 | 50 | 1400 | 2000 | 50 | 4950 | 1237.5000000000000000 | 4 + company2 | 07-02-2023 | 2000 | | | | | | | 0 + company2 | 07-03-2023 | 1500 | | | | | | | 0 + company2 | 07-04-2023 | 1400 | | | | | | | 0 + company2 | 07-05-2023 | 1500 | | | | | | | 0 + company2 | 07-06-2023 | 60 | 60 | 1200 | 1300 | 60 | 3660 | 915.0000000000000000 | 4 + company2 | 07-07-2023 | 1100 | | | | | | | 0 + company2 | 07-08-2023 | 1300 | | | | | | | 0 + company2 | 07-09-2023 | 1200 | | | | | | | 0 + company2 | 07-10-2023 | 1300 | | | | | | | 0 +(20 rows) + +-- using AFTER MATCH SKIP TO NEXT ROW +SELECT company, tdate, price, + first_value(price) OVER w, + last_value(price) OVER w, + max(price) OVER w, + min(price) OVER w, + sum(price) OVER w, + avg(price) OVER w, + count(price) OVER w +FROM stock +WINDOW w AS ( +PARTITION BY company +ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING +AFTER MATCH SKIP TO NEXT ROW +INITIAL +PATTERN (START UP+ DOWN+) +DEFINE +START AS TRUE, +UP AS price > PREV(price), +DOWN AS price < PREV(price) +); + company | tdate | price | first_value | last_value | max | min | sum | avg | count +----------+------------+-------+-------------+------------+------+------+------+-----------------------+------- + company1 | 07-01-2023 | 100 | 100 | 140 | 200 | 100 | 590 | 147.5000000000000000 | 4 + company1 | 07-02-2023 | 200 | | | | | | | 0 + company1 | 07-03-2023 | 150 | | | | | | | 0 + company1 | 07-04-2023 | 140 | 140 | 90 | 150 | 90 | 380 | 126.6666666666666667 | 3 + company1 | 07-05-2023 | 150 | | | | | | | 0 + company1 | 07-06-2023 | 90 | 90 | 120 | 130 | 90 | 450 | 112.5000000000000000 | 4 + company1 | 07-07-2023 | 110 | 110 | 120 | 130 | 110 | 360 | 120.0000000000000000 | 3 + company1 | 07-08-2023 | 130 | | | | | | | 0 + company1 | 07-09-2023 | 120 | | | | | | | 0 + company1 | 07-10-2023 | 130 | | | | | | | 0 + company2 | 07-01-2023 | 50 | 50 | 1400 | 2000 | 50 | 4950 | 1237.5000000000000000 | 4 + company2 | 07-02-2023 | 2000 | | | | | | | 0 + company2 | 07-03-2023 | 1500 | | | | | | | 0 + company2 | 07-04-2023 | 1400 | 1400 | 60 | 1500 | 60 | 2960 | 986.6666666666666667 | 3 + company2 | 07-05-2023 | 1500 | | | | | | | 0 + company2 | 07-06-2023 | 60 | 60 | 1200 | 1300 | 60 | 3660 | 915.0000000000000000 | 4 + company2 | 07-07-2023 | 1100 | 1100 | 1200 | 1300 | 1100 | 3600 | 1200.0000000000000000 | 3 + company2 | 07-08-2023 | 1300 | | | | | | | 0 + company2 | 07-09-2023 | 1200 | | | | | | | 0 + company2 | 07-10-2023 | 1300 | | | | | | | 0 +(20 rows) + +-- JOIN case +CREATE TEMP TABLE t1 (i int, v1 int); +CREATE TEMP TABLE t2 (j int, v2 int); +INSERT INTO t1 VALUES(1,10); +INSERT INTO t1 VALUES(1,11); +INSERT INTO t1 VALUES(1,12); +INSERT INTO t2 VALUES(2,10); +INSERT INTO t2 VALUES(2,11); +INSERT INTO t2 VALUES(2,12); +SELECT * FROM t1, t2 WHERE t1.v1 <= 11 AND t2.v2 <= 11; + i | v1 | j | v2 +---+----+---+---- + 1 | 10 | 2 | 10 + 1 | 10 | 2 | 11 + 1 | 11 | 2 | 10 + 1 | 11 | 2 | 11 +(4 rows) + +SELECT *, count(*) OVER w FROM t1, t2 +WINDOW w AS ( + PARTITION BY t1.i + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (A) + DEFINE + A AS v1 <= 11 AND v2 <= 11 +); + i | v1 | j | v2 | count +---+----+---+----+------- + 1 | 10 | 2 | 10 | 1 + 1 | 10 | 2 | 11 | 1 + 1 | 10 | 2 | 12 | 0 + 1 | 11 | 2 | 10 | 1 + 1 | 11 | 2 | 11 | 1 + 1 | 11 | 2 | 12 | 0 + 1 | 12 | 2 | 10 | 0 + 1 | 12 | 2 | 11 | 0 + 1 | 12 | 2 | 12 | 0 +(9 rows) + +-- WITH case +WITH wstock AS ( + SELECT * FROM stock WHERE tdate < '2023-07-08' +) +SELECT tdate, price, +first_value(tdate) OVER w, +count(*) OVER w + FROM wstock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + tdate | price | first_value | count +------------+-------+-------------+------- + 07-01-2023 | 100 | 07-01-2023 | 4 + 07-02-2023 | 200 | | 0 + 07-03-2023 | 150 | | 0 + 07-04-2023 | 140 | | 0 + 07-05-2023 | 150 | | 0 + 07-06-2023 | 90 | | 0 + 07-07-2023 | 110 | | 0 + 07-01-2023 | 50 | 07-01-2023 | 4 + 07-02-2023 | 2000 | | 0 + 07-03-2023 | 1500 | | 0 + 07-04-2023 | 1400 | | 0 + 07-05-2023 | 1500 | | 0 + 07-06-2023 | 60 | | 0 + 07-07-2023 | 1100 | | 0 +(14 rows) + +-- +-- Error cases +-- +-- row pattern definition variable name must not appear more than once +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price), + UP AS price > PREV(price) +); +ERROR: row pattern definition variable name "up" appears more than once in DEFINE clause +LINE 11: UP AS price > PREV(price), + ^ +-- subqueries in DEFINE clause are not supported +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START LOWPRICE) + DEFINE + START AS TRUE, + LOWPRICE AS price < (SELECT 100) +); +ERROR: cannot use subquery in DEFINE expression +LINE 11: LOWPRICE AS price < (SELECT 100) + ^ +-- aggregates in DEFINE clause are not supported +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START LOWPRICE) + DEFINE + START AS TRUE, + LOWPRICE AS price < count(*) +); +ERROR: aggregate functions are not allowed in DEFINE +LINE 11: LOWPRICE AS price < count(*) + ^ +-- FRAME must start at current row when row patttern recognition is used +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); +ERROR: FRAME must start at current row when row patttern recognition is used +-- SEEK is not supported +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP TO NEXT ROW + SEEK + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); +ERROR: SEEK is not supported +LINE 8: SEEK + ^ +HINT: Use INITIAL. diff --git a/src/test/regress/parallel_schedule b/src/test/regress/parallel_schedule index f53a526f7c..299354c9ae 100644 --- a/src/test/regress/parallel_schedule +++ b/src/test/regress/parallel_schedule @@ -98,7 +98,7 @@ test: publication subscription # Another group of parallel tests # select_views depends on create_view # ---------- -test: select_views portals_p2 foreign_key cluster dependency guc bitmapops combocid tsearch tsdicts foreign_data window xmlmap functional_deps advisory_lock indirect_toast equivclass +test: select_views portals_p2 foreign_key cluster dependency guc bitmapops combocid tsearch tsdicts foreign_data window xmlmap functional_deps advisory_lock indirect_toast equivclass rpr # ---------- # Another group of parallel tests (JSON related) diff --git a/src/test/regress/sql/rpr.sql b/src/test/regress/sql/rpr.sql new file mode 100644 index 0000000000..302e2b86a5 --- /dev/null +++ b/src/test/regress/sql/rpr.sql @@ -0,0 +1,405 @@ +-- +-- Test for row pattern definition clause +-- + +CREATE TEMP TABLE stock ( + company TEXT, + tdate DATE, + price INTEGER +); +INSERT INTO stock VALUES ('company1', '2023-07-01', 100); +INSERT INTO stock VALUES ('company1', '2023-07-02', 200); +INSERT INTO stock VALUES ('company1', '2023-07-03', 150); +INSERT INTO stock VALUES ('company1', '2023-07-04', 140); +INSERT INTO stock VALUES ('company1', '2023-07-05', 150); +INSERT INTO stock VALUES ('company1', '2023-07-06', 90); +INSERT INTO stock VALUES ('company1', '2023-07-07', 110); +INSERT INTO stock VALUES ('company1', '2023-07-08', 130); +INSERT INTO stock VALUES ('company1', '2023-07-09', 120); +INSERT INTO stock VALUES ('company1', '2023-07-10', 130); +INSERT INTO stock VALUES ('company2', '2023-07-01', 50); +INSERT INTO stock VALUES ('company2', '2023-07-02', 2000); +INSERT INTO stock VALUES ('company2', '2023-07-03', 1500); +INSERT INTO stock VALUES ('company2', '2023-07-04', 1400); +INSERT INTO stock VALUES ('company2', '2023-07-05', 1500); +INSERT INTO stock VALUES ('company2', '2023-07-06', 60); +INSERT INTO stock VALUES ('company2', '2023-07-07', 1100); +INSERT INTO stock VALUES ('company2', '2023-07-08', 1300); +INSERT INTO stock VALUES ('company2', '2023-07-09', 1200); +INSERT INTO stock VALUES ('company2', '2023-07-10', 1300); + +SELECT * FROM stock; + +-- basic test using PREV +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- basic test using PREV. UP appears twice +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+ UP+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- basic test using PREV. Use '*' +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP* DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- basic test with none greedy pattern +SELECT company, tdate, price, count(*) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (A A A) + DEFINE + A AS price >= 140 AND price <= 150 +); + +-- last_value() should remain consistent +SELECT company, tdate, price, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- omit "START" in DEFINE but it is ok because "START AS TRUE" is +-- implicitly defined. per spec. +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w, + nth_value(tdate, 2) OVER w AS nth_second + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- the first row start with less than or equal to 100 +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (LOWPRICE UP+ DOWN+) + DEFINE + LOWPRICE AS price <= 100, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- second row raises 120% +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (LOWPRICE UP+ DOWN+) + DEFINE + LOWPRICE AS price <= 100, + UP AS price > PREV(price) * 1.2, + DOWN AS price < PREV(price) +); + +-- using NEXT +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UPDOWN) + DEFINE + START AS TRUE, + UPDOWN AS price > PREV(price) AND price > NEXT(price) +); + +-- using AFTER MATCH SKIP TO NEXT ROW +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP TO NEXT ROW + INITIAL + PATTERN (START UPDOWN) + DEFINE + START AS TRUE, + UPDOWN AS price > PREV(price) AND price > NEXT(price) +); + +-- match everything + +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP PAST LAST ROW + INITIAL + PATTERN (A+) + DEFINE + A AS TRUE +); + +-- backtracking with reclassification of rows +-- using AFTER MATCH SKIP PAST LAST ROW +SELECT company, tdate, price, first_value(tdate) OVER w, last_value(tdate) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP PAST LAST ROW + INITIAL + PATTERN (A+ B+) + DEFINE + A AS price > 100, + B AS price > 100 +); + +-- backtracking with reclassification of rows +-- using AFTER MATCH SKIP TO NEXT ROW +SELECT company, tdate, price, first_value(tdate) OVER w, last_value(tdate) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP TO NEXT ROW + INITIAL + PATTERN (A+ B+) + DEFINE + A AS price > 100, + B AS price > 100 +); + +-- ROWS BETWEEN CURRENT ROW AND offset FOLLOWING +SELECT company, tdate, price, first_value(tdate) OVER w, last_value(tdate) OVER w, + count(*) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND 2 FOLLOWING + AFTER MATCH SKIP PAST LAST ROW + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- +-- Aggregates +-- + +-- using AFTER MATCH SKIP PAST LAST ROW +SELECT company, tdate, price, + first_value(price) OVER w, + last_value(price) OVER w, + max(price) OVER w, + min(price) OVER w, + sum(price) OVER w, + avg(price) OVER w, + count(price) OVER w +FROM stock +WINDOW w AS ( +PARTITION BY company +ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING +AFTER MATCH SKIP PAST LAST ROW +INITIAL +PATTERN (START UP+ DOWN+) +DEFINE +START AS TRUE, +UP AS price > PREV(price), +DOWN AS price < PREV(price) +); + +-- using AFTER MATCH SKIP TO NEXT ROW +SELECT company, tdate, price, + first_value(price) OVER w, + last_value(price) OVER w, + max(price) OVER w, + min(price) OVER w, + sum(price) OVER w, + avg(price) OVER w, + count(price) OVER w +FROM stock +WINDOW w AS ( +PARTITION BY company +ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING +AFTER MATCH SKIP TO NEXT ROW +INITIAL +PATTERN (START UP+ DOWN+) +DEFINE +START AS TRUE, +UP AS price > PREV(price), +DOWN AS price < PREV(price) +); + +-- JOIN case +CREATE TEMP TABLE t1 (i int, v1 int); +CREATE TEMP TABLE t2 (j int, v2 int); +INSERT INTO t1 VALUES(1,10); +INSERT INTO t1 VALUES(1,11); +INSERT INTO t1 VALUES(1,12); +INSERT INTO t2 VALUES(2,10); +INSERT INTO t2 VALUES(2,11); +INSERT INTO t2 VALUES(2,12); + +SELECT * FROM t1, t2 WHERE t1.v1 <= 11 AND t2.v2 <= 11; + +SELECT *, count(*) OVER w FROM t1, t2 +WINDOW w AS ( + PARTITION BY t1.i + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (A) + DEFINE + A AS v1 <= 11 AND v2 <= 11 +); + +-- WITH case +WITH wstock AS ( + SELECT * FROM stock WHERE tdate < '2023-07-08' +) +SELECT tdate, price, +first_value(tdate) OVER w, +count(*) OVER w + FROM wstock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- +-- Error cases +-- + +-- row pattern definition variable name must not appear more than once +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price), + UP AS price > PREV(price) +); + +-- subqueries in DEFINE clause are not supported +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START LOWPRICE) + DEFINE + START AS TRUE, + LOWPRICE AS price < (SELECT 100) +); + +-- aggregates in DEFINE clause are not supported +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START LOWPRICE) + DEFINE + START AS TRUE, + LOWPRICE AS price < count(*) +); + +-- FRAME must start at current row when row patttern recognition is used +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING + INITIAL + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); + +-- SEEK is not supported +SELECT company, tdate, price, first_value(price) OVER w, last_value(price) OVER w + FROM stock + WINDOW w AS ( + PARTITION BY company + ORDER BY tdate + ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING + AFTER MATCH SKIP TO NEXT ROW + SEEK + PATTERN (START UP+ DOWN+) + DEFINE + START AS TRUE, + UP AS price > PREV(price), + DOWN AS price < PREV(price) +); -- 2.25.1 ----Next_Part(Mon_Aug_26_13_39_47_2024_878)-- Content-Type: Text/X-Patch; charset=us-ascii Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="v21-0008-Allow-to-print-raw-parse-tree.patch" ^ permalink raw reply [nested|flat] 43+ messages in thread
end of thread, other threads:[~2024-08-26 04:32 UTC | newest] Thread overview: 43+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2024-03-21 17:51 Re: Introduce XID age and inactive timeout based replication slot invalidation Bharath Rupireddy <[email protected]> 2024-03-22 05:19 ` Amit Kapila <[email protected]> 2024-03-22 07:09 ` Bertrand Drouvot <[email protected]> 2024-03-22 08:15 ` Bharath Rupireddy <[email protected]> 2024-03-22 08:57 ` Bertrand Drouvot <[email protected]> 2024-03-22 09:29 ` Amit Kapila <[email protected]> 2024-03-22 09:53 ` Bertrand Drouvot <[email protected]> 2024-03-22 10:46 ` Amit Kapila <[email protected]> 2024-03-22 12:03 ` Bertrand Drouvot <[email protected]> 2024-03-22 09:45 ` Bertrand Drouvot <[email protected]> 2024-03-22 10:26 ` Amit Kapila <[email protected]> 2024-03-22 12:00 ` Bertrand Drouvot <[email protected]> 2024-03-22 12:32 ` Amit Kapila <[email protected]> 2024-03-22 13:47 ` Bertrand Drouvot <[email protected]> 2024-03-23 05:06 ` Amit Kapila <[email protected]> 2024-03-22 21:32 ` Bharath Rupireddy <[email protected]> 2024-03-23 05:57 ` Amit Kapila <[email protected]> 2024-03-23 07:41 ` Bharath Rupireddy <[email protected]> 2024-03-23 09:04 ` Bertrand Drouvot <[email protected]> 2024-03-24 02:30 ` Bharath Rupireddy <[email protected]> 2024-03-24 05:10 ` Amit Kapila <[email protected]> 2024-03-24 09:35 ` Bharath Rupireddy <[email protected]> 2024-03-25 04:18 ` Amit Kapila <[email protected]> 2024-03-25 04:58 ` Amit Kapila <[email protected]> 2024-03-25 06:55 ` Bharath Rupireddy <[email protected]> 2024-03-25 07:35 ` Bertrand Drouvot <[email protected]> 2024-03-25 05:03 ` shveta malik <[email protected]> 2024-03-25 06:23 ` shveta malik <[email protected]> 2024-03-25 07:13 ` shveta malik <[email protected]> 2024-03-26 04:00 ` shveta malik <[email protected]> 2024-03-26 05:37 ` Bharath Rupireddy <[email protected]> 2024-03-26 06:34 ` shveta malik <[email protected]> 2024-03-26 07:45 ` Bertrand Drouvot <[email protected]> 2024-03-25 19:54 ` Nathan Bossart <[email protected]> 2024-03-26 04:43 ` Amit Kapila <[email protected]> 2024-03-26 05:56 ` Amit Kapila <[email protected]> 2024-03-26 08:57 ` Bharath Rupireddy <[email protected]> 2024-03-26 09:22 ` shveta malik <[email protected]> 2024-03-26 09:42 ` Bertrand Drouvot <[email protected]> 2024-03-26 10:21 ` Amit Kapila <[email protected]> 2024-03-26 10:22 ` Ajin Cherian <[email protected]> 2024-03-22 12:24 ` Ajin Cherian <[email protected]> 2024-08-26 04:32 [PATCH v21 7/8] Row pattern recognition patch (tests). Tatsuo Ishii <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox