Add RecoveryStopsHook for extensions to handle custom WAL records

Author: za-arthur

src/backend/access/transam/xlogrecovery.c

@@ -2617,8 +2617,28 @@ recoveryStopsBefore(XLogReaderState *record)
 		return true;
 	}
 
+	/* Check RecoveryStopsHook for custom records */
+	if (RmgrIdIsCustom(XLogRecGetRmid(record)) && (RecoveryStopsBeforeHook != NULL))
+	{
+		stopsHere = RecoveryStopsBeforeHook(record, &recordXid, &recordXtime);
+
+		if (stopsHere)
+		{
+			recoveryStopAfter = false;
+			recoveryStopXid = recordXid;
+			recoveryStopLSN = InvalidXLogRecPtr;
+			recoveryStopTime = recordXtime;
+			recoveryStopName[0] = '\0';
+
+			ereport(LOG,
+					(errmsg("recovery stopping by hook before transaction %u, time %s",
+							recoveryStopXid,
+							timestamptz_to_str(recoveryStopTime))));
+			return true;
+		}
+	}
 	/* Otherwise we only consider stopping before COMMIT or ABORT records. */
-	if (XLogRecGetRmid(record) != RM_XACT_ID)
+	else if (XLogRecGetRmid(record) != RM_XACT_ID)
 		return false;
 
 	xact_info = XLogRecGetInfo(record) & XLOG_XACT_OPMASK;
@@ -4556,6 +4576,8 @@ GetXLogReplayRecPtr(TimeLineID *replayTLI)
 
 GetReplayXlogPtrHookType GetReplayXlogPtrHook = NULL;
 
+RecoveryStopsBeforeHookType RecoveryStopsBeforeHook = NULL;
+
 /*
  * Get effective latest redo apply position.
  *

src/include/access/xlogrecovery.h

@@ -50,6 +50,10 @@ typedef enum RecoveryPauseState
 
 typedef XLogRecPtr (*GetReplayXlogPtrHookType) (void);
 
+typedef bool (*RecoveryStopsBeforeHookType) (XLogReaderState *record,
+											 TransactionId *recordXid,
+											 TimestampTz *recordXtime);
+
 /* User-settable GUC parameters */
 extern PGDLLIMPORT bool recoveryTargetInclusive;
 extern PGDLLIMPORT int recoveryTargetAction;
@@ -81,6 +85,12 @@ extern PGDLLIMPORT bool StandbyMode;
 /* Hook for extensions to tune replay xlog pointer */
 extern PGDLLIMPORT GetReplayXlogPtrHookType GetReplayXlogPtrHook;
 
+/*
+ * Hook for extensions to be able to decides to stop applying the WAL files
+ * based on custom WAL records.
+ */
+extern PGDLLIMPORT RecoveryStopsBeforeHookType RecoveryStopsBeforeHook;
+
 extern Size XLogRecoveryShmemSize(void);
 extern void XLogRecoveryShmemInit(void);