PostgreSQL Source Code  git master
slotfuncs.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * slotfuncs.c
4  * Support functions for replication slots
5  *
6  * Copyright (c) 2012-2023, PostgreSQL Global Development Group
7  *
8  * IDENTIFICATION
9  * src/backend/replication/slotfuncs.c
10  *
11  *-------------------------------------------------------------------------
12  */
13 #include "postgres.h"
14 
15 #include "access/htup_details.h"
16 #include "access/xlog_internal.h"
17 #include "access/xlogrecovery.h"
18 #include "access/xlogutils.h"
19 #include "funcapi.h"
20 #include "miscadmin.h"
21 #include "replication/decode.h"
22 #include "replication/logical.h"
23 #include "replication/slot.h"
24 #include "utils/builtins.h"
25 #include "utils/inval.h"
26 #include "utils/pg_lsn.h"
27 #include "utils/resowner.h"
28 
29 /*
30  * Helper function for creating a new physical replication slot with
31  * given arguments. Note that this function doesn't release the created
32  * slot.
33  *
34  * If restart_lsn is a valid value, we use it without WAL reservation
35  * routine. So the caller must guarantee that WAL is available.
36  */
37 static void
38 create_physical_replication_slot(char *name, bool immediately_reserve,
39  bool temporary, XLogRecPtr restart_lsn)
40 {
42 
43  /* acquire replication slot, this will check for conflicting names */
45  temporary ? RS_TEMPORARY : RS_PERSISTENT, false);
46 
47  if (immediately_reserve)
48  {
49  /* Reserve WAL as the user asked for it */
50  if (XLogRecPtrIsInvalid(restart_lsn))
52  else
53  MyReplicationSlot->data.restart_lsn = restart_lsn;
54 
55  /* Write this slot to disk */
58  }
59 }
60 
61 /*
62  * SQL function for creating a new physical (streaming replication)
63  * replication slot.
64  */
65 Datum
67 {
69  bool immediately_reserve = PG_GETARG_BOOL(1);
70  bool temporary = PG_GETARG_BOOL(2);
71  Datum values[2];
72  bool nulls[2];
73  TupleDesc tupdesc;
74  HeapTuple tuple;
75  Datum result;
76 
77  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
78  elog(ERROR, "return type must be a row type");
79 
81 
83 
85  immediately_reserve,
86  temporary,
88 
90  nulls[0] = false;
91 
92  if (immediately_reserve)
93  {
95  nulls[1] = false;
96  }
97  else
98  nulls[1] = true;
99 
100  tuple = heap_form_tuple(tupdesc, values, nulls);
101  result = HeapTupleGetDatum(tuple);
102 
104 
105  PG_RETURN_DATUM(result);
106 }
107 
108 
109 /*
110  * Helper function for creating a new logical replication slot with
111  * given arguments. Note that this function doesn't release the created
112  * slot.
113  *
114  * When find_startpoint is false, the slot's confirmed_flush is not set; it's
115  * caller's responsibility to ensure it's set to something sensible.
116  */
117 static void
119  bool temporary, bool two_phase,
120  XLogRecPtr restart_lsn,
121  bool find_startpoint)
122 {
123  LogicalDecodingContext *ctx = NULL;
124 
126 
127  /*
128  * Acquire a logical decoding slot, this will check for conflicting names.
129  * Initially create persistent slot as ephemeral - that allows us to
130  * nicely handle errors during initialization because it'll get dropped if
131  * this transaction fails. We'll make it persistent at the end. Temporary
132  * slots can be created as temporary from beginning as they get dropped on
133  * error as well.
134  */
136  temporary ? RS_TEMPORARY : RS_EPHEMERAL, two_phase);
137 
138  /*
139  * Create logical decoding context to find start point or, if we don't
140  * need it, to 1) bump slot's restart_lsn and xmin 2) check plugin sanity.
141  *
142  * Note: when !find_startpoint this is still important, because it's at
143  * this point that the output plugin is validated.
144  */
146  false, /* just catalogs is OK */
147  restart_lsn,
148  XL_ROUTINE(.page_read = read_local_xlog_page,
149  .segment_open = wal_segment_open,
150  .segment_close = wal_segment_close),
151  NULL, NULL, NULL);
152 
153  /*
154  * If caller needs us to determine the decoding start point, do so now.
155  * This might take a while.
156  */
157  if (find_startpoint)
159 
160  /* don't need the decoding context anymore */
161  FreeDecodingContext(ctx);
162 }
163 
164 /*
165  * SQL function for creating a new logical replication slot.
166  */
167 Datum
169 {
170  Name name = PG_GETARG_NAME(0);
172  bool temporary = PG_GETARG_BOOL(2);
173  bool two_phase = PG_GETARG_BOOL(3);
174  Datum result;
175  TupleDesc tupdesc;
176  HeapTuple tuple;
177  Datum values[2];
178  bool nulls[2];
179 
180  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
181  elog(ERROR, "return type must be a row type");
182 
184 
186 
188  NameStr(*plugin),
189  temporary,
190  two_phase,
192  true);
193 
196 
197  memset(nulls, 0, sizeof(nulls));
198 
199  tuple = heap_form_tuple(tupdesc, values, nulls);
200  result = HeapTupleGetDatum(tuple);
201 
202  /* ok, slot is now fully created, mark it as persistent if needed */
203  if (!temporary)
206 
207  PG_RETURN_DATUM(result);
208 }
209 
210 
211 /*
212  * SQL function for dropping a replication slot.
213  */
214 Datum
216 {
217  Name name = PG_GETARG_NAME(0);
218 
220 
222 
224 
225  PG_RETURN_VOID();
226 }
227 
228 /*
229  * pg_get_replication_slots - SQL SRF showing all replication slots
230  * that currently exist on the database cluster.
231  */
232 Datum
234 {
235 #define PG_GET_REPLICATION_SLOTS_COLS 15
236  ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
237  XLogRecPtr currlsn;
238  int slotno;
239 
240  /*
241  * We don't require any special permission to see this function's data
242  * because nothing should be sensitive. The most critical being the slot
243  * name, which shouldn't contain anything particularly sensitive.
244  */
245 
246  InitMaterializedSRF(fcinfo, 0);
247 
248  currlsn = GetXLogWriteRecPtr();
249 
250  LWLockAcquire(ReplicationSlotControlLock, LW_SHARED);
251  for (slotno = 0; slotno < max_replication_slots; slotno++)
252  {
254  ReplicationSlot slot_contents;
256  bool nulls[PG_GET_REPLICATION_SLOTS_COLS];
257  WALAvailability walstate;
258  int i;
259 
260  if (!slot->in_use)
261  continue;
262 
263  /* Copy slot contents while holding spinlock, then examine at leisure */
264  SpinLockAcquire(&slot->mutex);
265  slot_contents = *slot;
266  SpinLockRelease(&slot->mutex);
267 
268  memset(values, 0, sizeof(values));
269  memset(nulls, 0, sizeof(nulls));
270 
271  i = 0;
272  values[i++] = NameGetDatum(&slot_contents.data.name);
273 
274  if (slot_contents.data.database == InvalidOid)
275  nulls[i++] = true;
276  else
277  values[i++] = NameGetDatum(&slot_contents.data.plugin);
278 
279  if (slot_contents.data.database == InvalidOid)
280  values[i++] = CStringGetTextDatum("physical");
281  else
282  values[i++] = CStringGetTextDatum("logical");
283 
284  if (slot_contents.data.database == InvalidOid)
285  nulls[i++] = true;
286  else
287  values[i++] = ObjectIdGetDatum(slot_contents.data.database);
288 
289  values[i++] = BoolGetDatum(slot_contents.data.persistency == RS_TEMPORARY);
290  values[i++] = BoolGetDatum(slot_contents.active_pid != 0);
291 
292  if (slot_contents.active_pid != 0)
293  values[i++] = Int32GetDatum(slot_contents.active_pid);
294  else
295  nulls[i++] = true;
296 
297  if (slot_contents.data.xmin != InvalidTransactionId)
298  values[i++] = TransactionIdGetDatum(slot_contents.data.xmin);
299  else
300  nulls[i++] = true;
301 
302  if (slot_contents.data.catalog_xmin != InvalidTransactionId)
303  values[i++] = TransactionIdGetDatum(slot_contents.data.catalog_xmin);
304  else
305  nulls[i++] = true;
306 
307  if (slot_contents.data.restart_lsn != InvalidXLogRecPtr)
308  values[i++] = LSNGetDatum(slot_contents.data.restart_lsn);
309  else
310  nulls[i++] = true;
311 
312  if (slot_contents.data.confirmed_flush != InvalidXLogRecPtr)
313  values[i++] = LSNGetDatum(slot_contents.data.confirmed_flush);
314  else
315  nulls[i++] = true;
316 
317  /*
318  * If the slot has not been invalidated, test availability from
319  * restart_lsn.
320  */
321  if (slot_contents.data.invalidated != RS_INVAL_NONE)
322  walstate = WALAVAIL_REMOVED;
323  else
324  walstate = GetWALAvailability(slot_contents.data.restart_lsn);
325 
326  switch (walstate)
327  {
329  nulls[i++] = true;
330  break;
331 
332  case WALAVAIL_RESERVED:
333  values[i++] = CStringGetTextDatum("reserved");
334  break;
335 
336  case WALAVAIL_EXTENDED:
337  values[i++] = CStringGetTextDatum("extended");
338  break;
339 
340  case WALAVAIL_UNRESERVED:
341  values[i++] = CStringGetTextDatum("unreserved");
342  break;
343 
344  case WALAVAIL_REMOVED:
345 
346  /*
347  * If we read the restart_lsn long enough ago, maybe that file
348  * has been removed by now. However, the walsender could have
349  * moved forward enough that it jumped to another file after
350  * we looked. If checkpointer signalled the process to
351  * termination, then it's definitely lost; but if a process is
352  * still alive, then "unreserved" seems more appropriate.
353  *
354  * If we do change it, save the state for safe_wal_size below.
355  */
356  if (!XLogRecPtrIsInvalid(slot_contents.data.restart_lsn))
357  {
358  int pid;
359 
360  SpinLockAcquire(&slot->mutex);
361  pid = slot->active_pid;
362  slot_contents.data.restart_lsn = slot->data.restart_lsn;
363  SpinLockRelease(&slot->mutex);
364  if (pid != 0)
365  {
366  values[i++] = CStringGetTextDatum("unreserved");
367  walstate = WALAVAIL_UNRESERVED;
368  break;
369  }
370  }
371  values[i++] = CStringGetTextDatum("lost");
372  break;
373  }
374 
375  /*
376  * safe_wal_size is only computed for slots that have not been lost,
377  * and only if there's a configured maximum size.
378  */
379  if (walstate == WALAVAIL_REMOVED || max_slot_wal_keep_size_mb < 0)
380  nulls[i++] = true;
381  else
382  {
383  XLogSegNo targetSeg;
384  uint64 slotKeepSegs;
385  uint64 keepSegs;
386  XLogSegNo failSeg;
387  XLogRecPtr failLSN;
388 
389  XLByteToSeg(slot_contents.data.restart_lsn, targetSeg, wal_segment_size);
390 
391  /* determine how many segments can be kept by slots */
393  /* ditto for wal_keep_size */
395 
396  /* if currpos reaches failLSN, we lose our segment */
397  failSeg = targetSeg + Max(slotKeepSegs, keepSegs) + 1;
398  XLogSegNoOffsetToRecPtr(failSeg, 0, wal_segment_size, failLSN);
399 
400  values[i++] = Int64GetDatum(failLSN - currlsn);
401  }
402 
403  values[i++] = BoolGetDatum(slot_contents.data.two_phase);
404 
405  if (slot_contents.data.database == InvalidOid)
406  nulls[i++] = true;
407  else
408  {
409  if (slot_contents.data.invalidated != RS_INVAL_NONE)
410  values[i++] = BoolGetDatum(true);
411  else
412  values[i++] = BoolGetDatum(false);
413  }
414 
416 
417  tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc,
418  values, nulls);
419  }
420 
421  LWLockRelease(ReplicationSlotControlLock);
422 
423  return (Datum) 0;
424 }
425 
426 /*
427  * Helper function for advancing our physical replication slot forward.
428  *
429  * The LSN position to move to is compared simply to the slot's restart_lsn,
430  * knowing that any position older than that would be removed by successive
431  * checkpoints.
432  */
433 static XLogRecPtr
435 {
437  XLogRecPtr retlsn = startlsn;
438 
439  Assert(moveto != InvalidXLogRecPtr);
440 
441  if (startlsn < moveto)
442  {
446  retlsn = moveto;
447 
448  /*
449  * Dirty the slot so as it is written out at the next checkpoint. Note
450  * that the LSN position advanced may still be lost in the event of a
451  * crash, but this makes the data consistent after a clean shutdown.
452  */
454  }
455 
456  return retlsn;
457 }
458 
459 /*
460  * Helper function for advancing our logical replication slot forward.
461  *
462  * The slot's restart_lsn is used as start point for reading records, while
463  * confirmed_flush is used as base point for the decoding context.
464  *
465  * We cannot just do LogicalConfirmReceivedLocation to update confirmed_flush,
466  * because we need to digest WAL to advance restart_lsn allowing to recycle
467  * WAL and removal of old catalog tuples. As decoding is done in fast_forward
468  * mode, no changes are generated anyway.
469  */
470 static XLogRecPtr
472 {
474  ResourceOwner old_resowner = CurrentResourceOwner;
475  XLogRecPtr retlsn;
476 
477  Assert(moveto != InvalidXLogRecPtr);
478 
479  PG_TRY();
480  {
481  /*
482  * Create our decoding context in fast_forward mode, passing start_lsn
483  * as InvalidXLogRecPtr, so that we start processing from my slot's
484  * confirmed_flush.
485  */
487  NIL,
488  true, /* fast_forward */
489  XL_ROUTINE(.page_read = read_local_xlog_page,
490  .segment_open = wal_segment_open,
491  .segment_close = wal_segment_close),
492  NULL, NULL, NULL);
493 
494  /*
495  * Start reading at the slot's restart_lsn, which we know to point to
496  * a valid record.
497  */
499 
500  /* invalidate non-timetravel entries */
502 
503  /* Decode at least one record, until we run out of records */
504  while (ctx->reader->EndRecPtr < moveto)
505  {
506  char *errm = NULL;
507  XLogRecord *record;
508 
509  /*
510  * Read records. No changes are generated in fast_forward mode,
511  * but snapbuilder/slot statuses are updated properly.
512  */
513  record = XLogReadRecord(ctx->reader, &errm);
514  if (errm)
515  elog(ERROR, "could not find record while advancing replication slot: %s",
516  errm);
517 
518  /*
519  * Process the record. Storage-level changes are ignored in
520  * fast_forward mode, but other modules (such as snapbuilder)
521  * might still have critical updates to do.
522  */
523  if (record)
525 
526  /* Stop once the requested target has been reached */
527  if (moveto <= ctx->reader->EndRecPtr)
528  break;
529 
531  }
532 
533  /*
534  * Logical decoding could have clobbered CurrentResourceOwner during
535  * transaction management, so restore the executor's value. (This is
536  * a kluge, but it's not worth cleaning up right now.)
537  */
538  CurrentResourceOwner = old_resowner;
539 
540  if (ctx->reader->EndRecPtr != InvalidXLogRecPtr)
541  {
543 
544  /*
545  * If only the confirmed_flush LSN has changed the slot won't get
546  * marked as dirty by the above. Callers on the walsender
547  * interface are expected to keep track of their own progress and
548  * don't need it written out. But SQL-interface users cannot
549  * specify their own start positions and it's harder for them to
550  * keep track of their progress, so we should make more of an
551  * effort to save it for them.
552  *
553  * Dirty the slot so it is written out at the next checkpoint. The
554  * LSN position advanced to may still be lost on a crash but this
555  * makes the data consistent after a clean shutdown.
556  */
558  }
559 
561 
562  /* free context, call shutdown callback */
563  FreeDecodingContext(ctx);
564 
566  }
567  PG_CATCH();
568  {
569  /* clear all timetravel entries */
571 
572  PG_RE_THROW();
573  }
574  PG_END_TRY();
575 
576  return retlsn;
577 }
578 
579 /*
580  * SQL function for moving the position in a replication slot.
581  */
582 Datum
584 {
585  Name slotname = PG_GETARG_NAME(0);
586  XLogRecPtr moveto = PG_GETARG_LSN(1);
587  XLogRecPtr endlsn;
588  XLogRecPtr minlsn;
589  TupleDesc tupdesc;
590  Datum values[2];
591  bool nulls[2];
592  HeapTuple tuple;
593  Datum result;
594 
596 
598 
599  if (XLogRecPtrIsInvalid(moveto))
600  ereport(ERROR,
601  (errmsg("invalid target WAL LSN")));
602 
603  /* Build a tuple descriptor for our result type */
604  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
605  elog(ERROR, "return type must be a row type");
606 
607  /*
608  * We can't move slot past what's been flushed/replayed so clamp the
609  * target position accordingly.
610  */
611  if (!RecoveryInProgress())
612  moveto = Min(moveto, GetFlushRecPtr(NULL));
613  else
614  moveto = Min(moveto, GetXLogReplayRecPtr(NULL));
615 
616  /* Acquire the slot so we "own" it */
617  ReplicationSlotAcquire(NameStr(*slotname), true);
618 
619  /* A slot whose restart_lsn has never been reserved cannot be advanced */
621  ereport(ERROR,
622  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
623  errmsg("replication slot \"%s\" cannot be advanced",
624  NameStr(*slotname)),
625  errdetail("This slot has never previously reserved WAL, or it has been invalidated.")));
626 
627  /*
628  * Check if the slot is not moving backwards. Physical slots rely simply
629  * on restart_lsn as a minimum point, while logical slots have confirmed
630  * consumption up to confirmed_flush, meaning that in both cases data
631  * older than that is not available anymore.
632  */
635  else
637 
638  if (moveto < minlsn)
639  ereport(ERROR,
640  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
641  errmsg("cannot advance replication slot to %X/%X, minimum is %X/%X",
642  LSN_FORMAT_ARGS(moveto), LSN_FORMAT_ARGS(minlsn))));
643 
644  /* Do the actual slot update, depending on the slot type */
646  endlsn = pg_logical_replication_slot_advance(moveto);
647  else
648  endlsn = pg_physical_replication_slot_advance(moveto);
649 
651  nulls[0] = false;
652 
653  /*
654  * Recompute the minimum LSN and xmin across all slots to adjust with the
655  * advancing potentially done.
656  */
659 
661 
662  /* Return the reached position. */
663  values[1] = LSNGetDatum(endlsn);
664  nulls[1] = false;
665 
666  tuple = heap_form_tuple(tupdesc, values, nulls);
667  result = HeapTupleGetDatum(tuple);
668 
669  PG_RETURN_DATUM(result);
670 }
671 
672 /*
673  * Helper function of copying a replication slot.
674  */
675 static Datum
676 copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot)
677 {
678  Name src_name = PG_GETARG_NAME(0);
679  Name dst_name = PG_GETARG_NAME(1);
680  ReplicationSlot *src = NULL;
681  ReplicationSlot first_slot_contents;
682  ReplicationSlot second_slot_contents;
683  XLogRecPtr src_restart_lsn;
684  bool src_islogical;
685  bool temporary;
686  char *plugin;
687  Datum values[2];
688  bool nulls[2];
689  Datum result;
690  TupleDesc tupdesc;
691  HeapTuple tuple;
692 
693  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
694  elog(ERROR, "return type must be a row type");
695 
697 
698  if (logical_slot)
700  else
702 
703  LWLockAcquire(ReplicationSlotControlLock, LW_SHARED);
704 
705  /*
706  * We need to prevent the source slot's reserved WAL from being removed,
707  * but we don't want to lock that slot for very long, and it can advance
708  * in the meantime. So obtain the source slot's data, and create a new
709  * slot using its restart_lsn. Afterwards we lock the source slot again
710  * and verify that the data we copied (name, type) has not changed
711  * incompatibly. No inconvenient WAL removal can occur once the new slot
712  * is created -- but since WAL removal could have occurred before we
713  * managed to create the new slot, we advance the new slot's restart_lsn
714  * to the source slot's updated restart_lsn the second time we lock it.
715  */
716  for (int i = 0; i < max_replication_slots; i++)
717  {
719 
720  if (s->in_use && strcmp(NameStr(s->data.name), NameStr(*src_name)) == 0)
721  {
722  /* Copy the slot contents while holding spinlock */
723  SpinLockAcquire(&s->mutex);
724  first_slot_contents = *s;
725  SpinLockRelease(&s->mutex);
726  src = s;
727  break;
728  }
729  }
730 
731  LWLockRelease(ReplicationSlotControlLock);
732 
733  if (src == NULL)
734  ereport(ERROR,
735  (errcode(ERRCODE_UNDEFINED_OBJECT),
736  errmsg("replication slot \"%s\" does not exist", NameStr(*src_name))));
737 
738  src_islogical = SlotIsLogical(&first_slot_contents);
739  src_restart_lsn = first_slot_contents.data.restart_lsn;
740  temporary = (first_slot_contents.data.persistency == RS_TEMPORARY);
741  plugin = logical_slot ? NameStr(first_slot_contents.data.plugin) : NULL;
742 
743  /* Check type of replication slot */
744  if (src_islogical != logical_slot)
745  ereport(ERROR,
746  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
747  src_islogical ?
748  errmsg("cannot copy physical replication slot \"%s\" as a logical replication slot",
749  NameStr(*src_name)) :
750  errmsg("cannot copy logical replication slot \"%s\" as a physical replication slot",
751  NameStr(*src_name))));
752 
753  /* Copying non-reserved slot doesn't make sense */
754  if (XLogRecPtrIsInvalid(src_restart_lsn))
755  ereport(ERROR,
756  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
757  errmsg("cannot copy a replication slot that doesn't reserve WAL")));
758 
759  /* Overwrite params from optional arguments */
760  if (PG_NARGS() >= 3)
761  temporary = PG_GETARG_BOOL(2);
762  if (PG_NARGS() >= 4)
763  {
764  Assert(logical_slot);
765  plugin = NameStr(*(PG_GETARG_NAME(3)));
766  }
767 
768  /* Create new slot and acquire it */
769  if (logical_slot)
770  {
771  /*
772  * We must not try to read WAL, since we haven't reserved it yet --
773  * hence pass find_startpoint false. confirmed_flush will be set
774  * below, by copying from the source slot.
775  */
777  plugin,
778  temporary,
779  false,
780  src_restart_lsn,
781  false);
782  }
783  else
785  true,
786  temporary,
787  src_restart_lsn);
788 
789  /*
790  * Update the destination slot to current values of the source slot;
791  * recheck that the source slot is still the one we saw previously.
792  */
793  {
794  TransactionId copy_effective_xmin;
795  TransactionId copy_effective_catalog_xmin;
796  TransactionId copy_xmin;
797  TransactionId copy_catalog_xmin;
798  XLogRecPtr copy_restart_lsn;
799  XLogRecPtr copy_confirmed_flush;
800  bool copy_islogical;
801  char *copy_name;
802 
803  /* Copy data of source slot again */
804  SpinLockAcquire(&src->mutex);
805  second_slot_contents = *src;
806  SpinLockRelease(&src->mutex);
807 
808  copy_effective_xmin = second_slot_contents.effective_xmin;
809  copy_effective_catalog_xmin = second_slot_contents.effective_catalog_xmin;
810 
811  copy_xmin = second_slot_contents.data.xmin;
812  copy_catalog_xmin = second_slot_contents.data.catalog_xmin;
813  copy_restart_lsn = second_slot_contents.data.restart_lsn;
814  copy_confirmed_flush = second_slot_contents.data.confirmed_flush;
815 
816  /* for existence check */
817  copy_name = NameStr(second_slot_contents.data.name);
818  copy_islogical = SlotIsLogical(&second_slot_contents);
819 
820  /*
821  * Check if the source slot still exists and is valid. We regard it as
822  * invalid if the type of replication slot or name has been changed,
823  * or the restart_lsn either is invalid or has gone backward. (The
824  * restart_lsn could go backwards if the source slot is dropped and
825  * copied from an older slot during installation.)
826  *
827  * Since erroring out will release and drop the destination slot we
828  * don't need to release it here.
829  */
830  if (copy_restart_lsn < src_restart_lsn ||
831  src_islogical != copy_islogical ||
832  strcmp(copy_name, NameStr(*src_name)) != 0)
833  ereport(ERROR,
834  (errmsg("could not copy replication slot \"%s\"",
835  NameStr(*src_name)),
836  errdetail("The source replication slot was modified incompatibly during the copy operation.")));
837 
838  /* The source slot must have a consistent snapshot */
839  if (src_islogical && XLogRecPtrIsInvalid(copy_confirmed_flush))
840  ereport(ERROR,
841  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
842  errmsg("cannot copy unfinished logical replication slot \"%s\"",
843  NameStr(*src_name)),
844  errhint("Retry when the source replication slot's confirmed_flush_lsn is valid.")));
845 
846  /* Install copied values again */
848  MyReplicationSlot->effective_xmin = copy_effective_xmin;
849  MyReplicationSlot->effective_catalog_xmin = copy_effective_catalog_xmin;
850 
851  MyReplicationSlot->data.xmin = copy_xmin;
852  MyReplicationSlot->data.catalog_xmin = copy_catalog_xmin;
853  MyReplicationSlot->data.restart_lsn = copy_restart_lsn;
854  MyReplicationSlot->data.confirmed_flush = copy_confirmed_flush;
856 
861 
862 #ifdef USE_ASSERT_CHECKING
863  /* Check that the restart_lsn is available */
864  {
865  XLogSegNo segno;
866 
867  XLByteToSeg(copy_restart_lsn, segno, wal_segment_size);
868  Assert(XLogGetLastRemovedSegno() < segno);
869  }
870 #endif
871  }
872 
873  /* target slot fully created, mark as persistent if needed */
874  if (logical_slot && !temporary)
876 
877  /* All done. Set up the return values */
878  values[0] = NameGetDatum(dst_name);
879  nulls[0] = false;
881  {
883  nulls[1] = false;
884  }
885  else
886  nulls[1] = true;
887 
888  tuple = heap_form_tuple(tupdesc, values, nulls);
889  result = HeapTupleGetDatum(tuple);
890 
892 
893  PG_RETURN_DATUM(result);
894 }
895 
896 /* The wrappers below are all to appease opr_sanity */
897 Datum
899 {
900  return copy_replication_slot(fcinfo, true);
901 }
902 
903 Datum
905 {
906  return copy_replication_slot(fcinfo, true);
907 }
908 
909 Datum
911 {
912  return copy_replication_slot(fcinfo, true);
913 }
914 
915 Datum
917 {
918  return copy_replication_slot(fcinfo, false);
919 }
920 
921 Datum
923 {
924  return copy_replication_slot(fcinfo, false);
925 }
static Datum values[MAXATTR]
Definition: bootstrap.c:156
#define CStringGetTextDatum(s)
Definition: builtins.h:94
#define NameStr(name)
Definition: c.h:735
#define Min(x, y)
Definition: c.h:993
#define Max(x, y)
Definition: c.h:987
uint32 TransactionId
Definition: c.h:641
#define OidIsValid(objectId)
Definition: c.h:764
void LogicalDecodingProcessRecord(LogicalDecodingContext *ctx, XLogReaderState *record)
Definition: decode.c:91
int errdetail(const char *fmt,...)
Definition: elog.c:1202
int errhint(const char *fmt,...)
Definition: elog.c:1316
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define PG_RE_THROW()
Definition: elog.h:411
#define PG_TRY(...)
Definition: elog.h:370
#define PG_END_TRY(...)
Definition: elog.h:395
#define ERROR
Definition: elog.h:39
#define PG_CATCH(...)
Definition: elog.h:380
#define ereport(elevel,...)
Definition: elog.h:149
Datum Int64GetDatum(int64 X)
Definition: fmgr.c:1790
#define PG_RETURN_VOID()
Definition: fmgr.h:349
#define PG_NARGS()
Definition: fmgr.h:203
#define PG_GETARG_NAME(n)
Definition: fmgr.h:278
#define PG_GETARG_BOOL(n)
Definition: fmgr.h:274
#define PG_RETURN_DATUM(x)
Definition: fmgr.h:353
#define PG_FUNCTION_ARGS
Definition: fmgr.h:193
void InitMaterializedSRF(FunctionCallInfo fcinfo, bits32 flags)
Definition: funcapi.c:76
TypeFuncClass get_call_result_type(FunctionCallInfo fcinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:276
@ TYPEFUNC_COMPOSITE
Definition: funcapi.h:149
static Datum HeapTupleGetDatum(const HeapTupleData *tuple)
Definition: funcapi.h:230
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:1108
void InvalidateSystemCaches(void)
Definition: inval.c:702
int i
Definition: isn.c:73
Assert(fmt[strlen(fmt) - 1] !='\n')
void LogicalConfirmReceivedLocation(XLogRecPtr lsn)
Definition: logical.c:1815
void FreeDecodingContext(LogicalDecodingContext *ctx)
Definition: logical.c:674
void DecodingContextFindStartpoint(LogicalDecodingContext *ctx)
Definition: logical.c:630
void CheckLogicalDecodingRequirements(void)
Definition: logical.c:108
LogicalDecodingContext * CreateInitDecodingContext(const char *plugin, List *output_plugin_options, bool need_full_snapshot, XLogRecPtr restart_lsn, XLogReaderRoutine *xl_routine, LogicalOutputPluginWriterPrepareWrite prepare_write, LogicalOutputPluginWriterWrite do_write, LogicalOutputPluginWriterUpdateProgress update_progress)
Definition: logical.c:328
LogicalDecodingContext * CreateDecodingContext(XLogRecPtr start_lsn, List *output_plugin_options, bool fast_forward, XLogReaderRoutine *xl_routine, LogicalOutputPluginWriterPrepareWrite prepare_write, LogicalOutputPluginWriterWrite do_write, LogicalOutputPluginWriterUpdateProgress update_progress)
Definition: logical.c:494
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1195
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1808
@ LW_SHARED
Definition: lwlock.h:117
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121
#define NIL
Definition: pg_list.h:68
#define PG_GETARG_LSN(n)
Definition: pg_lsn.h:33
static Datum LSNGetDatum(XLogRecPtr X)
Definition: pg_lsn.h:28
static bool two_phase
static const char * plugin
static Datum TransactionIdGetDatum(TransactionId X)
Definition: postgres.h:272
uintptr_t Datum
Definition: postgres.h:64
static Datum BoolGetDatum(bool X)
Definition: postgres.h:102
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
static Datum NameGetDatum(const NameData *X)
Definition: postgres.h:373
static Datum Int32GetDatum(int32 X)
Definition: postgres.h:212
#define InvalidOid
Definition: postgres_ext.h:36
ResourceOwner CurrentResourceOwner
Definition: resowner.c:147
void ReplicationSlotMarkDirty(void)
Definition: slot.c:798
void ReplicationSlotReserveWal(void)
Definition: slot.c:1175
void ReplicationSlotAcquire(const char *name, bool nowait)
Definition: slot.c:452
void ReplicationSlotsComputeRequiredXmin(bool already_locked)
Definition: slot.c:837
void ReplicationSlotPersist(void)
Definition: slot.c:815
ReplicationSlot * MyReplicationSlot
Definition: slot.c:99
void ReplicationSlotDrop(const char *name, bool nowait)
Definition: slot.c:643
void ReplicationSlotSave(void)
Definition: slot.c:780
void CheckSlotPermissions(void)
Definition: slot.c:1158
void ReplicationSlotRelease(void)
Definition: slot.c:549
int max_replication_slots
Definition: slot.c:102
ReplicationSlotCtlData * ReplicationSlotCtl
Definition: slot.c:96
void ReplicationSlotsComputeRequiredLSN(void)
Definition: slot.c:893
void ReplicationSlotCreate(const char *name, bool db_specific, ReplicationSlotPersistency persistency, bool two_phase)
Definition: slot.c:253
void CheckSlotRequirements(void)
Definition: slot.c:1136
@ RS_PERSISTENT
Definition: slot.h:35
@ RS_EPHEMERAL
Definition: slot.h:36
@ RS_TEMPORARY
Definition: slot.h:37
@ RS_INVAL_NONE
Definition: slot.h:46
#define SlotIsLogical(slot)
Definition: slot.h:191
Datum pg_get_replication_slots(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:233
Datum pg_copy_physical_replication_slot_a(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:916
static void create_logical_replication_slot(char *name, char *plugin, bool temporary, bool two_phase, XLogRecPtr restart_lsn, bool find_startpoint)
Definition: slotfuncs.c:118
Datum pg_create_logical_replication_slot(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:168
#define PG_GET_REPLICATION_SLOTS_COLS
static Datum copy_replication_slot(FunctionCallInfo fcinfo, bool logical_slot)
Definition: slotfuncs.c:676
Datum pg_copy_logical_replication_slot_c(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:910
Datum pg_create_physical_replication_slot(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:66
Datum pg_copy_logical_replication_slot_a(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:898
Datum pg_copy_physical_replication_slot_b(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:922
Datum pg_copy_logical_replication_slot_b(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:904
static XLogRecPtr pg_logical_replication_slot_advance(XLogRecPtr moveto)
Definition: slotfuncs.c:471
static XLogRecPtr pg_physical_replication_slot_advance(XLogRecPtr moveto)
Definition: slotfuncs.c:434
Datum pg_replication_slot_advance(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:583
static void create_physical_replication_slot(char *name, bool immediately_reserve, bool temporary, XLogRecPtr restart_lsn)
Definition: slotfuncs.c:38
Datum pg_drop_replication_slot(PG_FUNCTION_ARGS)
Definition: slotfuncs.c:215
#define SpinLockRelease(lock)
Definition: spin.h:64
#define SpinLockAcquire(lock)
Definition: spin.h:62
XLogReaderState * reader
Definition: logical.h:42
ReplicationSlot replication_slots[1]
Definition: slot.h:202
TransactionId xmin
Definition: slot.h:77
TransactionId catalog_xmin
Definition: slot.h:85
XLogRecPtr restart_lsn
Definition: slot.h:88
XLogRecPtr confirmed_flush
Definition: slot.h:99
ReplicationSlotPersistency persistency
Definition: slot.h:69
ReplicationSlotInvalidationCause invalidated
Definition: slot.h:91
TransactionId effective_catalog_xmin
Definition: slot.h:159
slock_t mutex
Definition: slot.h:135
pid_t active_pid
Definition: slot.h:141
bool in_use
Definition: slot.h:138
TransactionId effective_xmin
Definition: slot.h:158
ReplicationSlotPersistentData data
Definition: slot.h:162
TupleDesc setDesc
Definition: execnodes.h:334
Tuplestorestate * setResult
Definition: execnodes.h:333
XLogRecPtr EndRecPtr
Definition: xlogreader.h:207
Definition: c.h:730
#define InvalidTransactionId
Definition: transam.h:31
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, Datum *values, bool *isnull)
Definition: tuplestore.c:750
const char * name
bool RecoveryInProgress(void)
Definition: xlog.c:5948
XLogSegNo XLogGetLastRemovedSegno(void)
Definition: xlog.c:3491
int wal_keep_size_mb
Definition: xlog.c:119
int wal_segment_size
Definition: xlog.c:146
WALAvailability GetWALAvailability(XLogRecPtr targetLSN)
Definition: xlog.c:7391
int max_slot_wal_keep_size_mb
Definition: xlog.c:138
XLogRecPtr GetFlushRecPtr(TimeLineID *insertTLI)
Definition: xlog.c:6113
XLogRecPtr GetXLogWriteRecPtr(void)
Definition: xlog.c:8939
WALAvailability
Definition: xlog.h:182
@ WALAVAIL_REMOVED
Definition: xlog.h:188
@ WALAVAIL_RESERVED
Definition: xlog.h:184
@ WALAVAIL_UNRESERVED
Definition: xlog.h:187
@ WALAVAIL_EXTENDED
Definition: xlog.h:185
@ WALAVAIL_INVALID_LSN
Definition: xlog.h:183
#define XLogSegNoOffsetToRecPtr(segno, offset, wal_segsz_bytes, dest)
#define XLogMBVarToSegs(mbvar, wal_segsz_bytes)
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)
#define LSN_FORMAT_ARGS(lsn)
Definition: xlogdefs.h:43
#define XLogRecPtrIsInvalid(r)
Definition: xlogdefs.h:29
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
uint64 XLogSegNo
Definition: xlogdefs.h:48
XLogRecord * XLogReadRecord(XLogReaderState *state, char **errormsg)
Definition: xlogreader.c:406
void XLogBeginRead(XLogReaderState *state, XLogRecPtr RecPtr)
Definition: xlogreader.c:248
#define XL_ROUTINE(...)
Definition: xlogreader.h:117
XLogRecPtr GetXLogReplayRecPtr(TimeLineID *replayTLI)
void wal_segment_close(XLogReaderState *state)
Definition: xlogutils.c:844
void wal_segment_open(XLogReaderState *state, XLogSegNo nextSegNo, TimeLineID *tli_p)
Definition: xlogutils.c:819
int read_local_xlog_page(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page)
Definition: xlogutils.c:863