You've already forked pgbackrest
mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2025-07-05 00:28:52 +02:00
Refactor PostgreSQL interface to remove most code duplication.
Having a copy per version worked well until it was time to add new features or modify existing functions. Then it was necessary to modify every version and try to keep them all in sync. Consolidate all the PostgreSQL types into a single file using #if for type versions. Many types do not change or change infrequently so this cuts down on duplication. In addition, it is far easier to see what has changed when a new version is added. Use macros to write the interface functions. There is still duplication here since some changes require a new copy of the macro, but it is far less than before.
This commit is contained in:
David Steele
209
src/postgres/interface/version.intern.h
Normal file
209
src/postgres/interface/version.intern.h
Normal file
@ -0,0 +1,209 @@
|
||||
/***********************************************************************************************************************************
|
||||
PostgreSQL Version Interface
|
||||
|
||||
Macros for building version-specific functions that interface with the types in version.auto.h. Due to the way PostgreSQL types
|
||||
evolve over time, this seems to be the easiest way to extract information from them.
|
||||
|
||||
These macros should be kept as simple as possible, with most of the logic contained in postgres/interface.c.
|
||||
|
||||
Each version of PostgreSQL will need a vXXX.c file to contain the version-specific functions created by these macros.
|
||||
***********************************************************************************************************************************/
|
||||
#ifndef POSTGRES_INTERFACE_IMPLEMENTATION_H
|
||||
#define POSTGRES_INTERFACE_IMPLEMENTATION_H
|
||||
|
||||
#include "common/debug.h"
|
||||
#include "postgres/interface/version.h"
|
||||
#include "postgres/version.h"
|
||||
|
||||
#include "postgres/interface/version.auto.h"
|
||||
|
||||
/***********************************************************************************************************************************
|
||||
Determine if the supplied pg_control is for this version of PostgreSQL
|
||||
***********************************************************************************************************************************/
|
||||
#if PG_VERSION > PG_VERSION_MAX
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_83
|
||||
|
||||
#define PG_INTERFACE_CONTROL_IS(version) \
|
||||
bool \
|
||||
pgInterfaceControlIs##version(const unsigned char *controlFile) \
|
||||
{ \
|
||||
ASSERT(controlFile != NULL); \
|
||||
\
|
||||
return \
|
||||
((ControlFileData *)controlFile)->pg_control_version == PG_CONTROL_VERSION && \
|
||||
((ControlFileData *)controlFile)->catalog_version_no == CATALOG_VERSION_NO; \
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
/***********************************************************************************************************************************
|
||||
Read the version specific pg_control into a general data structure
|
||||
***********************************************************************************************************************************/
|
||||
#if PG_VERSION > PG_VERSION_MAX
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_93
|
||||
|
||||
#define PG_INTERFACE_CONTROL(version) \
|
||||
PgControl \
|
||||
pgInterfaceControl##version(const unsigned char *controlFile) \
|
||||
{ \
|
||||
ASSERT(controlFile != NULL); \
|
||||
ASSERT(pgInterfaceControlIs##version(controlFile)); \
|
||||
\
|
||||
return (PgControl) \
|
||||
{ \
|
||||
.systemId = ((ControlFileData *)controlFile)->system_identifier, \
|
||||
.controlVersion = ((ControlFileData *)controlFile)->pg_control_version, \
|
||||
.catalogVersion = ((ControlFileData *)controlFile)->catalog_version_no, \
|
||||
.pageSize = ((ControlFileData *)controlFile)->blcksz, \
|
||||
.walSegmentSize = ((ControlFileData *)controlFile)->xlog_seg_size, \
|
||||
.pageChecksum = ((ControlFileData *)controlFile)->data_checksum_version != 0, \
|
||||
}; \
|
||||
}
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_83
|
||||
|
||||
#define PG_INTERFACE_CONTROL(version) \
|
||||
PgControl \
|
||||
pgInterfaceControl##version(const unsigned char *controlFile) \
|
||||
{ \
|
||||
ASSERT(controlFile != NULL); \
|
||||
ASSERT(pgInterfaceControlIs##version(controlFile)); \
|
||||
\
|
||||
return (PgControl) \
|
||||
{ \
|
||||
.systemId = ((ControlFileData *)controlFile)->system_identifier, \
|
||||
.controlVersion = ((ControlFileData *)controlFile)->pg_control_version, \
|
||||
.catalogVersion = ((ControlFileData *)controlFile)->catalog_version_no, \
|
||||
.pageSize = ((ControlFileData *)controlFile)->blcksz, \
|
||||
.walSegmentSize = ((ControlFileData *)controlFile)->xlog_seg_size, \
|
||||
}; \
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
/***********************************************************************************************************************************
|
||||
Create a pg_control file for testing
|
||||
***********************************************************************************************************************************/
|
||||
#if PG_VERSION > PG_VERSION_MAX
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_93
|
||||
|
||||
#define PG_INTERFACE_CONTROL_TEST(version) \
|
||||
void \
|
||||
pgInterfaceControlTest##version(PgControl pgControl, unsigned char *buffer) \
|
||||
{ \
|
||||
ASSERT(buffer != NULL); \
|
||||
\
|
||||
((ControlFileData *)buffer)->system_identifier = pgControl.systemId; \
|
||||
((ControlFileData *)buffer)->pg_control_version = \
|
||||
pgControl.controlVersion == 0 ? PG_CONTROL_VERSION : pgControl.controlVersion; \
|
||||
((ControlFileData *)buffer)->catalog_version_no = \
|
||||
pgControl.catalogVersion == 0 ? CATALOG_VERSION_NO : pgControl.catalogVersion; \
|
||||
((ControlFileData *)buffer)->blcksz = pgControl.pageSize; \
|
||||
((ControlFileData *)buffer)->xlog_seg_size = pgControl.walSegmentSize; \
|
||||
((ControlFileData *)buffer)->data_checksum_version = pgControl.pageChecksum; \
|
||||
}
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_83
|
||||
|
||||
#define PG_INTERFACE_CONTROL_TEST(version) \
|
||||
void \
|
||||
pgInterfaceControlTest##version(PgControl pgControl, unsigned char *buffer) \
|
||||
{ \
|
||||
ASSERT(buffer != NULL); \
|
||||
ASSERT(!pgControl.pageChecksum); \
|
||||
\
|
||||
((ControlFileData *)buffer)->system_identifier = pgControl.systemId; \
|
||||
((ControlFileData *)buffer)->pg_control_version = \
|
||||
pgControl.controlVersion == 0 ? PG_CONTROL_VERSION : pgControl.controlVersion; \
|
||||
((ControlFileData *)buffer)->catalog_version_no = \
|
||||
pgControl.catalogVersion == 0 ? CATALOG_VERSION_NO : pgControl.catalogVersion; \
|
||||
((ControlFileData *)buffer)->blcksz = pgControl.pageSize; \
|
||||
((ControlFileData *)buffer)->xlog_seg_size = pgControl.walSegmentSize; \
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
/***********************************************************************************************************************************
|
||||
Determine if the supplied WAL is for this version of PostgreSQL
|
||||
***********************************************************************************************************************************/
|
||||
#if PG_VERSION > PG_VERSION_MAX
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_83
|
||||
|
||||
#define PG_INTERFACE_WAL_IS(version) \
|
||||
bool \
|
||||
pgInterfaceWalIs##version(const unsigned char *walFile) \
|
||||
{ \
|
||||
ASSERT(walFile != NULL); \
|
||||
\
|
||||
return ((XLogPageHeaderData *)walFile)->xlp_magic == XLOG_PAGE_MAGIC; \
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
/***********************************************************************************************************************************
|
||||
Read the version specific WAL header into a general data structure
|
||||
***********************************************************************************************************************************/
|
||||
#if PG_VERSION > PG_VERSION_MAX
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_83
|
||||
|
||||
#define PG_INTERFACE_WAL(version) \
|
||||
PgWal \
|
||||
pgInterfaceWal##version(const unsigned char *walFile) \
|
||||
{ \
|
||||
ASSERT(walFile != NULL); \
|
||||
ASSERT(pgInterfaceWalIs##version(walFile)); \
|
||||
\
|
||||
return (PgWal) \
|
||||
{ \
|
||||
.systemId = ((XLogLongPageHeaderData *)walFile)->xlp_sysid, \
|
||||
}; \
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
/***********************************************************************************************************************************
|
||||
Create a WAL file file for testing
|
||||
***********************************************************************************************************************************/
|
||||
#if PG_VERSION > PG_VERSION_MAX
|
||||
|
||||
#elif PG_VERSION >= PG_VERSION_83
|
||||
|
||||
#define PG_INTERFACE_WAL_TEST(version) \
|
||||
void \
|
||||
pgInterfaceWalTest##version(PgWal pgWal, unsigned char *buffer) \
|
||||
{ \
|
||||
((XLogLongPageHeaderData *)buffer)->std.xlp_magic = XLOG_PAGE_MAGIC; \
|
||||
((XLogLongPageHeaderData *)buffer)->xlp_sysid = pgWal.systemId; \
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
/***********************************************************************************************************************************
|
||||
Call all macros with a single macro to make the vXXX.c files as simple as possible
|
||||
***********************************************************************************************************************************/
|
||||
#define PG_INTERFACE_BASE(version) \
|
||||
PG_INTERFACE_CONTROL_IS(version) \
|
||||
PG_INTERFACE_CONTROL(version) \
|
||||
PG_INTERFACE_WAL_IS(version) \
|
||||
PG_INTERFACE_WAL(version)
|
||||
|
||||
#ifdef DEBUG
|
||||
|
||||
#define PG_INTERFACE(version) \
|
||||
PG_INTERFACE_BASE(version) \
|
||||
PG_INTERFACE_CONTROL_TEST(version) \
|
||||
PG_INTERFACE_WAL_TEST(version)
|
||||
|
||||
#else
|
||||
|
||||
#define PG_INTERFACE(version) \
|
||||
PG_INTERFACE_BASE(version)
|
||||
|
||||
#endif
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user