Move LSN waiting declarations and definitions to better place

akorotkov · akorotkov · commit 5035172e4ab5 · 2024-10-24T14:37:53.000+03:00
3c5db1d implemented the pg_wal_replay_wait() stored procedure. Due to the patch development history, the implementation resided in src/backend/commands/waitlsn.c (src/include/commands/waitlsn.h for headers). 014f9f3 moved pg_wal_replay_wait() itself to src/backend/access/transam/xlogfuncs.c near to the WAL-manipulation functions. But most of the implementation stayed in place. The code in src/backend/commands/waitlsn.c has nothing to do with commands, but is related to WAL. So, this commit moves this code into src/backend/access/transam/xlogwait.c (src/include/access/xlogwait.h for headers). Reported-by: Peter Eisentraut Discussion: https://postgr.es/m/18c0fa64-0475-415e-a1bd-665d922c5201%40eisentraut.org Reviewed-by: Pavel Borisov
diff --git a/src/backend/access/transam/Makefile b/src/backend/access/transam/Makefile
@@ -36,7 +36,8 @@ OBJS = \
 	xlogreader.o \
 	xlogrecovery.o \
 	xlogstats.o \
-	xlogutils.o
+	xlogutils.o \
+	xlogwait.o
 
 include $(top_srcdir)/src/backend/common.mk
 
diff --git a/src/backend/access/transam/meson.build b/src/backend/access/transam/meson.build
@@ -24,6 +24,7 @@ backend_sources += files(
   'xlogrecovery.c',
   'xlogstats.c',
   'xlogutils.c',
+  'xlogwait.c',
 )
 
 # used by frontend programs to build a frontend xlogreader
diff --git a/src/backend/access/transam/xact.c b/src/backend/access/transam/xact.c
@@ -31,14 +31,14 @@
 #include "access/xloginsert.h"
 #include "access/xlogrecovery.h"
 #include "access/xlogutils.h"
+#include "access/xlogwait.h"
 #include "catalog/index.h"
 #include "catalog/namespace.h"
 #include "catalog/pg_enum.h"
 #include "catalog/storage.h"
 #include "commands/async.h"
 #include "commands/tablecmds.h"
 #include "commands/trigger.h"
-#include "commands/waitlsn.h"
 #include "common/pg_prng.h"
 #include "executor/spi.h"
 #include "libpq/be-fsstubs.h"
diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c
@@ -62,11 +62,11 @@
 #include "access/xlogreader.h"
 #include "access/xlogrecovery.h"
 #include "access/xlogutils.h"
+#include "access/xlogwait.h"
 #include "backup/basebackup.h"
 #include "catalog/catversion.h"
 #include "catalog/pg_control.h"
 #include "catalog/pg_database.h"
-#include "commands/waitlsn.h"
 #include "common/controldata_utils.h"
 #include "common/file_utils.h"
 #include "executor/instrument.h"
diff --git a/src/backend/access/transam/xlogfuncs.c b/src/backend/access/transam/xlogfuncs.c
@@ -22,8 +22,8 @@
 #include "access/xlog_internal.h"
 #include "access/xlogbackup.h"
 #include "access/xlogrecovery.h"
+#include "access/xlogwait.h"
 #include "catalog/pg_type.h"
-#include "commands/waitlsn.h"
 #include "funcapi.h"
 #include "miscadmin.h"
 #include "pgstat.h"
diff --git a/src/backend/access/transam/xlogrecovery.c b/src/backend/access/transam/xlogrecovery.c
@@ -40,10 +40,10 @@
 #include "access/xlogreader.h"
 #include "access/xlogrecovery.h"
 #include "access/xlogutils.h"
+#include "access/xlogwait.h"
 #include "backup/basebackup.h"
 #include "catalog/pg_control.h"
 #include "commands/tablespace.h"
-#include "commands/waitlsn.h"
 #include "common/file_utils.h"
 #include "miscadmin.h"
 #include "pgstat.h"
diff --git a/src/backend/access/transam/xlogwait.c b/src/backend/access/transam/xlogwait.c
@@ -1,13 +1,13 @@
 /*-------------------------------------------------------------------------
  *
- * waitlsn.c
+ * xlogwait.c
  *	  Implements waiting for the given replay LSN, which is used in
  *	  CALL pg_wal_replay_wait(target_lsn pg_lsn, timeout float8).
  *
  * Copyright (c) 2024, PostgreSQL Global Development Group
  *
  * IDENTIFICATION
- *	  src/backend/commands/waitlsn.c
+ *	  src/backend/access/transam/xlogwait.c
  *
  *-------------------------------------------------------------------------
  */
@@ -20,7 +20,7 @@
 #include "pgstat.h"
 #include "access/xlog.h"
 #include "access/xlogrecovery.h"
-#include "commands/waitlsn.h"
+#include "access/xlogwait.h"
 #include "funcapi.h"
 #include "miscadmin.h"
 #include "storage/latch.h"
diff --git a/src/backend/commands/Makefile b/src/backend/commands/Makefile
@@ -61,7 +61,6 @@ OBJS = \
 	vacuum.o \
 	vacuumparallel.o \
 	variable.o \
-	view.o \
-	waitlsn.o
+	view.o
 
 include $(top_srcdir)/src/backend/common.mk
diff --git a/src/backend/commands/meson.build b/src/backend/commands/meson.build
@@ -50,5 +50,4 @@ backend_sources += files(
   'vacuumparallel.c',
   'variable.c',
   'view.c',
-  'waitlsn.c',
 )
diff --git a/src/backend/storage/ipc/ipci.c b/src/backend/storage/ipc/ipci.c
@@ -24,8 +24,8 @@
 #include "access/twophase.h"
 #include "access/xlogprefetcher.h"
 #include "access/xlogrecovery.h"
+#include "access/xlogwait.h"
 #include "commands/async.h"
-#include "commands/waitlsn.h"
 #include "miscadmin.h"
 #include "pgstat.h"
 #include "postmaster/autovacuum.h"
diff --git a/src/backend/storage/lmgr/proc.c b/src/backend/storage/lmgr/proc.c
@@ -36,7 +36,7 @@
 #include "access/transam.h"
 #include "access/twophase.h"
 #include "access/xlogutils.h"
-#include "commands/waitlsn.h"
+#include "access/xlogwait.h"
 #include "miscadmin.h"
 #include "pgstat.h"
 #include "postmaster/autovacuum.h"
diff --git a/src/include/access/xlogwait.h b/src/include/access/xlogwait.h
@@ -1,16 +1,16 @@
 /*-------------------------------------------------------------------------
  *
- * waitlsn.h
+ * xlogwait.h
  *	  Declarations for LSN replay waiting routines.
  *
  * Copyright (c) 2024, PostgreSQL Global Development Group
  *
- * src/include/commands/waitlsn.h
+ * src/include/access/xlogwait.h
  *
  *-------------------------------------------------------------------------
  */
-#ifndef WAIT_LSN_H
-#define WAIT_LSN_H
+#ifndef XLOG_WAIT_H
+#define XLOG_WAIT_H
 
 #include "lib/pairingheap.h"
 #include "postgres.h"
@@ -78,4 +78,4 @@ extern void WaitLSNSetLatches(XLogRecPtr currentLSN);
 extern void WaitLSNCleanup(void);
 extern void WaitForLSNReplay(XLogRecPtr targetLSN, int64 timeout);
 
-#endif							/* WAIT_LSN_H */
+#endif							/* XLOG_WAIT_H */

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ backend_sources += files(`
`24`	`24`	`'xlogrecovery.c',`
`25`	`25`	`'xlogstats.c',`
`26`	`26`	`'xlogutils.c',`
	`27`	`+ 'xlogwait.c',`
`27`	`28`	`)`
`28`	`29`
`29`	`30`	`# used by frontend programs to build a frontend xlogreader`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`/*-------------------------------------------------------------------------`
`2`	`2`	`*`
`3`		`- * waitlsn.c`
	`3`	`+ * xlogwait.c`
`4`	`4`	`* Implements waiting for the given replay LSN, which is used in`
`5`	`5`	`* CALL pg_wal_replay_wait(target_lsn pg_lsn, timeout float8).`
`6`	`6`	`*`
`7`	`7`	`* Copyright (c) 2024, PostgreSQL Global Development Group`
`8`	`8`	`*`
`9`	`9`	`* IDENTIFICATION`
`10`		`- * src/backend/commands/waitlsn.c`
	`10`	`+ * src/backend/access/transam/xlogwait.c`
`11`	`11`	`*`
`12`	`12`	`*-------------------------------------------------------------------------`
`13`	`13`	`*/`
`@@ -20,7 +20,7 @@`
`20`	`20`	`#include "pgstat.h"`
`21`	`21`	`#include "access/xlog.h"`
`22`	`22`	`#include "access/xlogrecovery.h"`
`23`		`-#include "commands/waitlsn.h"`
	`23`	`+#include "access/xlogwait.h"`
`24`	`24`	`#include "funcapi.h"`
`25`	`25`	`#include "miscadmin.h"`
`26`	`26`	`#include "storage/latch.h"`
Original file line number	Diff line number	Diff line change
`@@ -50,5 +50,4 @@ backend_sources += files(`
`50`	`50`	`'vacuumparallel.c',`
`51`	`51`	`'variable.c',`
`52`	`52`	`'view.c',`
`53`		`- 'waitlsn.c',`
`54`	`53`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,16 @@`
`1`	`1`	`/*-------------------------------------------------------------------------`
`2`	`2`	`*`
`3`		`- * waitlsn.h`
	`3`	`+ * xlogwait.h`
`4`	`4`	`* Declarations for LSN replay waiting routines.`
`5`	`5`	`*`
`6`	`6`	`* Copyright (c) 2024, PostgreSQL Global Development Group`
`7`	`7`	`*`
`8`		`- * src/include/commands/waitlsn.h`
	`8`	`+ * src/include/access/xlogwait.h`
`9`	`9`	`*`
`10`	`10`	`*-------------------------------------------------------------------------`
`11`	`11`	`*/`
`12`		`-#ifndef WAIT_LSN_H`
`13`		`-#define WAIT_LSN_H`
	`12`	`+#ifndef XLOG_WAIT_H`
	`13`	`+#define XLOG_WAIT_H`
`14`	`14`
`15`	`15`	`#include "lib/pairingheap.h"`
`16`	`16`	`#include "postgres.h"`
`@@ -78,4 +78,4 @@ extern void WaitLSNSetLatches(XLogRecPtr currentLSN);`
`78`	`78`	`extern void WaitLSNCleanup(void);`
`79`	`79`	`extern void WaitForLSNReplay(XLogRecPtr targetLSN, int64 timeout);`
`80`	`80`
`81`		`-#endif /* WAIT_LSN_H */`
	`81`	`+#endif /* XLOG_WAIT_H */`