From 1749d8ccd8134c590d69c5bc7f1937cc3815604b Mon Sep 17 00:00:00 2001 From: Andreas Karlsson Date: Tue, 10 Jun 2025 13:53:08 +0200 Subject: [PATCH] Sort header includes in a constent order Inspired by how PostgreSQL does it we support our includes in the following order: 1. postgres.h 2. System headers 3. PostgreSQL headers 4. pg_tde headers 5. Frontend/backend specific headers Within every section we sort includes in alphabetical order where possible, which right now was everywhere except in keyring_kmip_impl.c. --- contrib/pg_tde/src/access/pg_tde_tdemap.c | 22 ++++++------ contrib/pg_tde/src/access/pg_tde_xlog.c | 6 ++-- contrib/pg_tde/src/access/pg_tde_xlog_smgr.c | 6 ++-- contrib/pg_tde/src/catalog/tde_keyring.c | 28 ++++++++------- .../src/catalog/tde_keyring_parse_opts.c | 1 + .../pg_tde/src/catalog/tde_principal_key.c | 34 +++++++++--------- contrib/pg_tde/src/common/pg_tde_shmem.c | 6 ++-- contrib/pg_tde/src/common/pg_tde_utils.c | 4 +-- contrib/pg_tde/src/encryption/enc_aes.c | 23 ++++++------ contrib/pg_tde/src/encryption/enc_tde.c | 12 +++---- contrib/pg_tde/src/include/pg_tde_fe.h | 2 +- contrib/pg_tde/src/keyring/keyring_api.c | 14 ++++---- contrib/pg_tde/src/keyring/keyring_file.c | 13 +++---- contrib/pg_tde/src/keyring/keyring_kmip.c | 2 +- .../pg_tde/src/keyring/keyring_kmip_impl.c | 1 + contrib/pg_tde/src/keyring/keyring_vault.c | 17 +++++---- contrib/pg_tde/src/pg_tde.c | 30 ++++++++-------- .../pg_tde/src/pg_tde_change_key_provider.c | 13 +++---- contrib/pg_tde/src/pg_tde_event_capture.c | 36 ++++++++++--------- contrib/pg_tde/src/pg_tde_guc.c | 4 ++- contrib/pg_tde/src/smgr/pg_tde_smgr.c | 11 +++--- 21 files changed, 151 insertions(+), 134 deletions(-) diff --git a/contrib/pg_tde/src/access/pg_tde_tdemap.c b/contrib/pg_tde/src/access/pg_tde_tdemap.c index eb145194288..3ab258ea05e 100644 --- a/contrib/pg_tde/src/access/pg_tde_tdemap.c +++ b/contrib/pg_tde/src/access/pg_tde_tdemap.c @@ -1,14 +1,18 @@ #include "postgres.h" -#include "access/pg_tde_tdemap.h" -#include "common/file_perm.h" -#include "storage/fd.h" -#include "utils/wait_event.h" -#include "utils/memutils.h" + +#include +#include +#include + #include "access/xlog.h" #include "access/xlog_internal.h" #include "access/xloginsert.h" -#include "utils/builtins.h" +#include "common/file_perm.h" #include "miscadmin.h" +#include "storage/fd.h" +#include "utils/builtins.h" +#include "utils/memutils.h" +#include "utils/wait_event.h" #include "access/pg_tde_tdemap.h" #include "access/pg_tde_xlog.h" @@ -18,12 +22,6 @@ #include "encryption/enc_tde.h" #include "keyring/keyring_api.h" -#include -#include -#include - -#include "pg_tde_defines.h" - #ifdef FRONTEND #include "pg_tde_fe.h" #endif diff --git a/contrib/pg_tde/src/access/pg_tde_xlog.c b/contrib/pg_tde/src/access/pg_tde_xlog.c index 43407ee3698..14015f32b8d 100644 --- a/contrib/pg_tde/src/access/pg_tde_xlog.c +++ b/contrib/pg_tde/src/access/pg_tde_xlog.c @@ -12,19 +12,19 @@ #include "postgres.h" -#include "pg_tde.h" -#include "pg_tde_defines.h" #include "access/xlog.h" #include "access/xlog_internal.h" #include "access/xloginsert.h" -#include "catalog/tde_keyring.h" #include "storage/bufmgr.h" #include "storage/shmem.h" #include "utils/guc.h" #include "utils/memutils.h" #include "access/pg_tde_xlog.h" +#include "catalog/tde_keyring.h" #include "encryption/enc_tde.h" +#include "pg_tde.h" +#include "pg_tde_defines.h" #include "smgr/pg_tde_smgr.h" static void tdeheap_rmgr_redo(XLogReaderState *record); diff --git a/contrib/pg_tde/src/access/pg_tde_xlog_smgr.c b/contrib/pg_tde/src/access/pg_tde_xlog_smgr.c index 1f331e18e64..aec73ba3612 100644 --- a/contrib/pg_tde/src/access/pg_tde_xlog_smgr.c +++ b/contrib/pg_tde/src/access/pg_tde_xlog_smgr.c @@ -12,9 +12,6 @@ #include "postgres.h" -#include "pg_tde.h" -#include "pg_tde_defines.h" -#include "pg_tde_guc.h" #include "access/xlog.h" #include "access/xlog_internal.h" #include "access/xlog_smgr.h" @@ -28,6 +25,9 @@ #include "access/pg_tde_xlog_smgr.h" #include "catalog/tde_global_space.h" #include "encryption/enc_tde.h" +#include "pg_tde.h" +#include "pg_tde_defines.h" +#include "pg_tde_guc.h" #ifdef FRONTEND #include "pg_tde_fe.h" diff --git a/contrib/pg_tde/src/catalog/tde_keyring.c b/contrib/pg_tde/src/catalog/tde_keyring.c index 742bb5d2f8e..c5aee34e377 100644 --- a/contrib/pg_tde/src/catalog/tde_keyring.c +++ b/contrib/pg_tde/src/catalog/tde_keyring.c @@ -9,33 +9,37 @@ * *------------------------------------------------------------------------- */ + #include "postgres.h" + +#include + +#include "access/skey.h" #include "access/xlog.h" #include "access/xloginsert.h" +#include "miscadmin.h" +#include "storage/fd.h" +#include "utils/builtins.h" +#include "utils/fmgroids.h" +#include "utils/lsyscache.h" +#include "utils/memutils.h" +#include "utils/snapmgr.h" + #include "access/pg_tde_xlog.h" #include "catalog/tde_global_space.h" #include "catalog/tde_keyring.h" #include "catalog/tde_principal_key.h" -#include "access/skey.h" -#include "utils/lsyscache.h" -#include "utils/memutils.h" -#include "utils/snapmgr.h" -#include "utils/fmgroids.h" #include "common/pg_tde_utils.h" -#include "miscadmin.h" -#include "storage/fd.h" -#include "unistd.h" -#include "utils/builtins.h" #include "pg_tde.h" #ifndef FRONTEND #include "access/heapam.h" -#include "common/pg_tde_shmem.h" -#include "funcapi.h" -#include "access/relscan.h" #include "access/relation.h" +#include "access/relscan.h" #include "catalog/namespace.h" #include "executor/spi.h" +#include "funcapi.h" +#include "common/pg_tde_shmem.h" #else #include "fe_utils/simple_list.h" #include "pg_tde_fe.h" diff --git a/contrib/pg_tde/src/catalog/tde_keyring_parse_opts.c b/contrib/pg_tde/src/catalog/tde_keyring_parse_opts.c index 7414da764f2..f9e8a1db87d 100644 --- a/contrib/pg_tde/src/catalog/tde_keyring_parse_opts.c +++ b/contrib/pg_tde/src/catalog/tde_keyring_parse_opts.c @@ -12,6 +12,7 @@ */ #include "postgres.h" + #include "common/jsonapi.h" #include "mb/pg_wchar.h" #include "utils/jsonfuncs.h" diff --git a/contrib/pg_tde/src/catalog/tde_principal_key.c b/contrib/pg_tde/src/catalog/tde_principal_key.c index e115bfb7b40..21d71563752 100644 --- a/contrib/pg_tde/src/catalog/tde_principal_key.c +++ b/contrib/pg_tde/src/catalog/tde_principal_key.c @@ -9,43 +9,45 @@ * *------------------------------------------------------------------------- */ + #include "postgres.h" + +#include +#include + #include "access/xlog.h" #include "access/xloginsert.h" -#include "catalog/tde_principal_key.h" -#include "storage/fd.h" -#include "utils/palloc.h" -#include "utils/memutils.h" -#include "utils/wait_event.h" -#include "utils/timestamp.h" +#include "catalog/pg_database.h" #include "common/relpath.h" #include "miscadmin.h" +#include "storage/fd.h" #include "utils/builtins.h" -#include "pg_tde.h" -#include "access/pg_tde_xlog.h" -#include -#include #include "utils/fmgroids.h" #include "utils/guc.h" -#include "catalog/pg_database.h" -#include "keyring/keyring_api.h" +#include "utils/memutils.h" +#include "utils/palloc.h" +#include "utils/timestamp.h" +#include "utils/wait_event.h" #include "access/pg_tde_tdemap.h" +#include "access/pg_tde_xlog.h" #include "catalog/tde_global_space.h" +#include "catalog/tde_principal_key.h" +#include "keyring/keyring_api.h" +#include "pg_tde.h" +#include "pg_tde_guc.h" + #ifndef FRONTEND #include "access/genam.h" #include "access/table.h" -#include "common/pg_tde_shmem.h" #include "funcapi.h" #include "lib/dshash.h" #include "storage/lwlock.h" #include "storage/shmem.h" +#include "common/pg_tde_shmem.h" #else #include "pg_tde_fe.h" #endif -#include "pg_tde_guc.h" - -#include #ifndef FRONTEND diff --git a/contrib/pg_tde/src/common/pg_tde_shmem.c b/contrib/pg_tde/src/common/pg_tde_shmem.c index 6bd4c9578d6..697a3e23b68 100644 --- a/contrib/pg_tde/src/common/pg_tde_shmem.c +++ b/contrib/pg_tde/src/common/pg_tde_shmem.c @@ -10,13 +10,15 @@ */ #include "postgres.h" -#include "storage/ipc.h" -#include "common/pg_tde_shmem.h" + #include "lib/dshash.h" #include "nodes/pg_list.h" +#include "storage/ipc.h" #include "storage/lwlock.h" #include "storage/shmem.h" +#include "common/pg_tde_shmem.h" + static void tde_shmem_shutdown(int code, Datum arg); List *registeredShmemRequests = NIL; diff --git a/contrib/pg_tde/src/common/pg_tde_utils.c b/contrib/pg_tde/src/common/pg_tde_utils.c index e092557f90c..4a6602ce05f 100644 --- a/contrib/pg_tde/src/common/pg_tde_utils.c +++ b/contrib/pg_tde/src/common/pg_tde_utils.c @@ -15,10 +15,10 @@ #include "pg_tde.h" #ifndef FRONTEND -#include "fmgr.h" -#include "smgr/pg_tde_smgr.h" #include "access/relation.h" +#include "fmgr.h" #include "utils/rel.h" +#include "smgr/pg_tde_smgr.h" PG_FUNCTION_INFO_V1(pg_tde_is_encrypted); Datum diff --git a/contrib/pg_tde/src/encryption/enc_aes.c b/contrib/pg_tde/src/encryption/enc_aes.c index 003f6050112..65064516846 100644 --- a/contrib/pg_tde/src/encryption/enc_aes.c +++ b/contrib/pg_tde/src/encryption/enc_aes.c @@ -1,22 +1,21 @@ #include "postgres.h" -#ifdef FRONTEND -#include "pg_tde_fe.h" -#endif - -#include "encryption/enc_aes.h" - +#include +#include +#include +#include +#include +#include #include #include #include -#include -#include #include -#include -#include -#include -#include +#include "encryption/enc_aes.h" + +#ifdef FRONTEND +#include "pg_tde_fe.h" +#endif /* Implementation notes * ===================== diff --git a/contrib/pg_tde/src/encryption/enc_tde.c b/contrib/pg_tde/src/encryption/enc_tde.c index 2676efb92aa..f5324741f0e 100644 --- a/contrib/pg_tde/src/encryption/enc_tde.c +++ b/contrib/pg_tde/src/encryption/enc_tde.c @@ -1,19 +1,19 @@ -#include "pg_tde_defines.h" - #include "postgres.h" +#include +#include + +#include "storage/bufmgr.h" + #include "access/pg_tde_tdemap.h" #include "encryption/enc_tde.h" #include "encryption/enc_aes.h" -#include "storage/bufmgr.h" +#include "pg_tde_defines.h" #ifdef FRONTEND #include "pg_tde_fe.h" #endif -#include -#include - #define AES_BLOCK_SIZE 16 #define NUM_AES_BLOCKS_IN_BATCH 200 #define DATA_BYTES_PER_AES_BATCH (NUM_AES_BLOCKS_IN_BATCH * AES_BLOCK_SIZE) diff --git a/contrib/pg_tde/src/include/pg_tde_fe.h b/contrib/pg_tde/src/include/pg_tde_fe.h index 196457a0522..79c1c4f4fa7 100644 --- a/contrib/pg_tde/src/include/pg_tde_fe.h +++ b/contrib/pg_tde/src/include/pg_tde_fe.h @@ -13,9 +13,9 @@ #ifdef FRONTEND #include "postgres_fe.h" -#include "utils/elog.h" #include "common/logging.h" #include "common/file_perm.h" +#include "utils/elog.h" #pragma GCC diagnostic ignored "-Wunused-macros" #pragma GCC diagnostic ignored "-Wunused-value" diff --git a/contrib/pg_tde/src/keyring/keyring_api.c b/contrib/pg_tde/src/keyring/keyring_api.c index 618ff2da7a2..4af3c82130d 100644 --- a/contrib/pg_tde/src/keyring/keyring_api.c +++ b/contrib/pg_tde/src/keyring/keyring_api.c @@ -1,17 +1,19 @@ -#include "keyring/keyring_api.h" - #include "postgres.h" + +#include +#include +#include + #include "nodes/pg_list.h" #include "utils/memutils.h" + +#include "keyring/keyring_api.h" + #ifdef FRONTEND #include "fe_utils/simple_list.h" #include "pg_tde_fe.h" #endif -#include -#include -#include - typedef struct RegisteredKeyProviderType { TDEKeyringRoutine *routine; diff --git a/contrib/pg_tde/src/keyring/keyring_file.c b/contrib/pg_tde/src/keyring/keyring_file.c index 2166b8ef954..391b6dae91d 100644 --- a/contrib/pg_tde/src/keyring/keyring_file.c +++ b/contrib/pg_tde/src/keyring/keyring_file.c @@ -12,20 +12,21 @@ #include "postgres.h" -#include "keyring/keyring_file.h" -#include "catalog/tde_keyring.h" +#include +#include + #include "common/file_perm.h" -#include "keyring/keyring_api.h" #include "storage/fd.h" #include "utils/wait_event.h" +#include "catalog/tde_keyring.h" +#include "keyring/keyring_api.h" +#include "keyring/keyring_file.h" + #ifdef FRONTEND #include "pg_tde_fe.h" #endif -#include -#include - static KeyInfo *get_key_by_name(GenericKeyring *keyring, const char *key_name, KeyringReturnCodes *return_code); static void set_key_by_name(GenericKeyring *keyring, KeyInfo *key); static void validate(GenericKeyring *keyring); diff --git a/contrib/pg_tde/src/keyring/keyring_kmip.c b/contrib/pg_tde/src/keyring/keyring_kmip.c index bcec5425818..12dbcab8d16 100644 --- a/contrib/pg_tde/src/keyring/keyring_kmip.c +++ b/contrib/pg_tde/src/keyring/keyring_kmip.c @@ -14,9 +14,9 @@ #include #include +#include "keyring/keyring_api.h" #include "keyring/keyring_kmip.h" #include "keyring/keyring_kmip_impl.h" -#include "keyring/keyring_api.h" #ifdef FRONTEND #include "pg_tde_fe.h" diff --git a/contrib/pg_tde/src/keyring/keyring_kmip_impl.c b/contrib/pg_tde/src/keyring/keyring_kmip_impl.c index 086373e4c82..54a5fba89d2 100644 --- a/contrib/pg_tde/src/keyring/keyring_kmip_impl.c +++ b/contrib/pg_tde/src/keyring/keyring_kmip_impl.c @@ -2,6 +2,7 @@ * The libkmip specific code need to be in a separate library to avoid * collissions with PostgreSQL's header files. */ + #include #include #include diff --git a/contrib/pg_tde/src/keyring/keyring_vault.c b/contrib/pg_tde/src/keyring/keyring_vault.c index 1c013578992..4d896e5ffb6 100644 --- a/contrib/pg_tde/src/keyring/keyring_vault.c +++ b/contrib/pg_tde/src/keyring/keyring_vault.c @@ -11,19 +11,18 @@ #include "postgres.h" -#include "keyring/keyring_vault.h" -#include "keyring/keyring_curl.h" -#include "keyring/keyring_api.h" -#include "pg_tde_defines.h" +#include +#include + +#include "common/base64.h" #include "common/jsonapi.h" #include "mb/pg_wchar.h" #include "utils/builtins.h" -#include - -#include - -#include "common/base64.h" +#include "keyring/keyring_api.h" +#include "keyring/keyring_curl.h" +#include "keyring/keyring_vault.h" +#include "pg_tde_defines.h" #ifdef FRONTEND #include "pg_tde_fe.h" diff --git a/contrib/pg_tde/src/pg_tde.c b/contrib/pg_tde/src/pg_tde.c index 410c7ce7cb6..f38ad795609 100644 --- a/contrib/pg_tde/src/pg_tde.c +++ b/contrib/pg_tde/src/pg_tde.c @@ -11,33 +11,35 @@ */ #include "postgres.h" + +#include + +#include "access/tableam.h" +#include "access/xlog.h" +#include "access/xloginsert.h" #include "funcapi.h" -#include "pg_tde.h" #include "miscadmin.h" #include "storage/ipc.h" #include "storage/lwlock.h" #include "storage/shmem.h" +#include "utils/builtins.h" +#include "utils/percona.h" + +#include "access/pg_tde_tdemap.h" #include "access/pg_tde_xlog.h" #include "access/pg_tde_xlog_smgr.h" +#include "catalog/tde_global_space.h" +#include "catalog/tde_principal_key.h" +#include "common/pg_tde_shmem.h" #include "encryption/enc_aes.h" -#include "access/pg_tde_tdemap.h" -#include "access/xlog.h" -#include "access/xloginsert.h" #include "keyring/keyring_api.h" -#include "common/pg_tde_shmem.h" -#include "catalog/tde_principal_key.h" #include "keyring/keyring_file.h" -#include "keyring/keyring_vault.h" #include "keyring/keyring_kmip.h" -#include "utils/builtins.h" -#include "smgr/pg_tde_smgr.h" -#include "catalog/tde_global_space.h" +#include "keyring/keyring_vault.h" +#include "pg_tde.h" #include "pg_tde_event_capture.h" -#include "utils/percona.h" #include "pg_tde_guc.h" -#include "access/tableam.h" - -#include +#include "smgr/pg_tde_smgr.h" PG_MODULE_MAGIC; diff --git a/contrib/pg_tde/src/pg_tde_change_key_provider.c b/contrib/pg_tde/src/pg_tde_change_key_provider.c index 341c182e93e..79d69ae7ccb 100644 --- a/contrib/pg_tde/src/pg_tde_change_key_provider.c +++ b/contrib/pg_tde/src/pg_tde_change_key_provider.c @@ -1,14 +1,15 @@ #include "postgres_fe.h" -#include "pg_tde.h" -#include "catalog/tde_keyring.h" -#include "catalog/tde_global_space.h" +#include +#include + #include "common/controldata_utils.h" #include "common/logging.h" -#include "common/pg_tde_utils.h" -#include -#include +#include "catalog/tde_global_space.h" +#include "catalog/tde_keyring.h" +#include "common/pg_tde_utils.h" +#include "pg_tde.h" /* version string we expect back from pg_tde_change_key_provider */ #define PROGNAME "pg_tde_change_key_provider (PostgreSQL) " PG_VERSION "\n" diff --git a/contrib/pg_tde/src/pg_tde_event_capture.c b/contrib/pg_tde/src/pg_tde_event_capture.c index 74cb36bb88a..fef9cf2b31d 100644 --- a/contrib/pg_tde/src/pg_tde_event_capture.c +++ b/contrib/pg_tde/src/pg_tde_event_capture.c @@ -10,34 +10,36 @@ */ #include "postgres.h" -#include "funcapi.h" -#include "fmgr.h" -#include "utils/rel.h" -#include "utils/builtins.h" -#include "utils/lsyscache.h" + +#include "access/heapam.h" +#include "access/relation.h" +#include "access/table.h" +#include "access/tableam.h" +#include "catalog/namespace.h" #include "catalog/pg_class.h" #include "catalog/pg_database.h" +#include "catalog/pg_event_trigger.h" #include "catalog/pg_inherits.h" #include "commands/defrem.h" -#include "commands/sequence.h" -#include "access/heapam.h" -#include "access/table.h" -#include "access/relation.h" -#include "catalog/pg_event_trigger.h" -#include "catalog/namespace.h" #include "commands/event_trigger.h" -#include "common/pg_tde_utils.h" +#include "commands/sequence.h" +#include "fmgr.h" +#include "funcapi.h" +#include "miscadmin.h" #include "storage/lmgr.h" #include "tcop/utility.h" +#include "utils/builtins.h" #include "utils/fmgroids.h" +#include "utils/lsyscache.h" +#include "utils/rel.h" #include "utils/syscache.h" -#include "pg_tde_event_capture.h" -#include "pg_tde_guc.h" + #include "access/pg_tde_tdemap.h" -#include "catalog/tde_principal_key.h" -#include "miscadmin.h" -#include "access/tableam.h" #include "catalog/tde_global_space.h" +#include "catalog/tde_principal_key.h" +#include "common/pg_tde_utils.h" +#include "pg_tde_event_capture.h" +#include "pg_tde_guc.h" typedef struct { diff --git a/contrib/pg_tde/src/pg_tde_guc.c b/contrib/pg_tde/src/pg_tde_guc.c index 5e11c3d21e9..8b82c3338bc 100644 --- a/contrib/pg_tde/src/pg_tde_guc.c +++ b/contrib/pg_tde/src/pg_tde_guc.c @@ -10,10 +10,12 @@ *------------------------------------------------------------------------- */ -#include "pg_tde_guc.h" #include "postgres.h" + #include "utils/guc.h" +#include "pg_tde_guc.h" + #ifndef FRONTEND bool AllowInheritGlobalProviders = true; diff --git a/contrib/pg_tde/src/smgr/pg_tde_smgr.c b/contrib/pg_tde/src/smgr/pg_tde_smgr.c index 476a30369e1..12f68bc555d 100644 --- a/contrib/pg_tde/src/smgr/pg_tde_smgr.c +++ b/contrib/pg_tde/src/smgr/pg_tde_smgr.c @@ -1,16 +1,17 @@ #include "postgres.h" -#include "smgr/pg_tde_smgr.h" -#include "storage/smgr.h" -#include "storage/md.h" #include "access/xloginsert.h" #include "catalog/catalog.h" +#include "storage/md.h" +#include "storage/smgr.h" +#include "utils/hsearch.h" + +#include "access/pg_tde_tdemap.h" #include "access/pg_tde_xlog.h" #include "encryption/enc_aes.h" #include "encryption/enc_tde.h" -#include "access/pg_tde_tdemap.h" -#include "utils/hsearch.h" #include "pg_tde_event_capture.h" +#include "smgr/pg_tde_smgr.h" typedef enum TDEMgrRelationEncryptionStatus {