Skip to content

Use OpenTransientFile() instead of BasicOpenFile() #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2025
Merged

Use OpenTransientFile() instead of BasicOpenFile() #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions contrib/pg_tde/src/access/pg_tde_tdemap.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ pg_tde_save_principal_key_redo(const TDESignedPrincipalKeyInfo *signed_key_info)
LWLockAcquire(tde_lwlock_enc_keys(), LW_EXCLUSIVE);

map_fd = pg_tde_open_file_write(db_map_path, signed_key_info, false, &curr_pos);
close(map_fd);
CloseTransientFile(map_fd);

LWLockRelease(tde_lwlock_enc_keys());
}
Expand Down Expand Up @@ -216,7 +216,7 @@ pg_tde_save_principal_key(const TDEPrincipalKey *principal_key, bool write_xlog)
}

map_fd = pg_tde_open_file_write(db_map_path, &signed_key_Info, true, &curr_pos);
close(map_fd);
CloseTransientFile(map_fd);
}

/*
Expand Down Expand Up @@ -365,7 +365,7 @@ pg_tde_write_key_map_entry(const RelFileLocator *rlocator, const InternalKey *re
/* Write the given entry at curr_pos; i.e. the free entry. */
pg_tde_write_one_map_entry(map_fd, &write_map_entry, &curr_pos, db_map_path);

close(map_fd);
CloseTransientFile(map_fd);
}

/*
Expand Down Expand Up @@ -410,7 +410,7 @@ pg_tde_free_key_map_entry(const RelFileLocator rlocator)
}
}

close(map_fd);
CloseTransientFile(map_fd);

LWLockRelease(tde_lwlock_enc_keys());
}
Expand Down Expand Up @@ -490,8 +490,8 @@ pg_tde_perform_rotate_key(TDEPrincipalKey *principal_key, TDEPrincipalKey *new_p
pfree(rel_key_data);
}

close(old_fd);
close(new_fd);
CloseTransientFile(old_fd);
CloseTransientFile(new_fd);

/*
* Do the final steps - replace the current _map with the file with new
Expand Down Expand Up @@ -589,7 +589,7 @@ pg_tde_wal_last_key_set_lsn(XLogRecPtr lsn, const char *keyfile_path)
}

LWLockRelease(lock_pk);
close(fd);
CloseTransientFile(fd);
}

/*
Expand Down Expand Up @@ -649,7 +649,7 @@ pg_tde_find_map_entry(const RelFileLocator *rlocator, TDEMapEntryType key_type,
}
}

close(map_fd);
CloseTransientFile(map_fd);

return found;
}
Expand Down Expand Up @@ -688,7 +688,7 @@ pg_tde_count_relations(Oid dbOid)
count++;
}

close(map_fd);
CloseTransientFile(map_fd);

LWLockRelease(lock_pk);

Expand Down Expand Up @@ -764,7 +764,7 @@ pg_tde_open_file_basic(const char *tde_filename, int fileFlags, bool ignore_miss
{
int fd;

fd = BasicOpenFile(tde_filename, fileFlags);
fd = OpenTransientFile(tde_filename, fileFlags);
if (fd < 0 && !(errno == ENOENT && ignore_missing == true))
{
ereport(ERROR,
Expand Down Expand Up @@ -792,7 +792,6 @@ pg_tde_file_header_read(const char *tde_filename, int fd, TDEFileHeader *fheader
if (*bytes_read != TDE_FILE_HEADER_SIZE
|| fheader->file_version != PG_TDE_FILEMAGIC)
{
close(fd);
ereport(FATAL,
errcode_for_file_access(),
errmsg("TDE map file \"%s\" is corrupted: %m", tde_filename));
Expand Down Expand Up @@ -870,7 +869,7 @@ pg_tde_get_principal_key_info(Oid dbOid)

pg_tde_file_header_read(db_map_path, fd, &fheader, &bytes_read);

close(fd);
CloseTransientFile(fd);

/*
* It's not a new file. So we can copy the principal key info from the
Expand Down Expand Up @@ -1008,6 +1007,7 @@ pg_tde_read_last_wal_key(void)
if (fsize == TDE_FILE_HEADER_SIZE)
{
LWLockRelease(lock_pk);
CloseTransientFile(fd);
return NULL;
}

Expand All @@ -1016,7 +1016,7 @@ pg_tde_read_last_wal_key(void)

rel_key_data = tde_decrypt_rel_key(principal_key, &map_entry);
LWLockRelease(lock_pk);
close(fd);
CloseTransientFile(fd);

return rel_key_data;
}
Expand Down Expand Up @@ -1064,7 +1064,7 @@ pg_tde_fetch_wal_keys(XLogRecPtr start_lsn)
wal_rec = pg_tde_add_wal_key_to_cache(&stub_key, InvalidXLogRecPtr);

LWLockRelease(lock_pk);
close(fd);
CloseTransientFile(fd);
return wal_rec;
}

Expand Down Expand Up @@ -1094,7 +1094,7 @@ pg_tde_fetch_wal_keys(XLogRecPtr start_lsn)
}
}
LWLockRelease(lock_pk);
close(fd);
CloseTransientFile(fd);

return return_wal_rec;
}
Expand Down
20 changes: 8 additions & 12 deletions contrib/pg_tde/src/catalog/tde_keyring.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,13 +476,12 @@ save_new_key_provider_info(KeyringProviderRecord *provider, Oid databaseId)

if (strcmp(existing_provider.provider_name, provider->provider_name) == 0)
{
close(fd);
ereport(ERROR,
errcode(ERRCODE_DUPLICATE_OBJECT),
errmsg("Key provider \"%s\" already exists.", provider->provider_name));
}
}
close(fd);
CloseTransientFile(fd);

if (max_provider_id == PG_INT32_MAX)
{
Expand Down Expand Up @@ -610,7 +609,7 @@ write_key_provider_info(KeyringProviderRecordInFile *record, bool write_xlog)
Assert(LWLockHeldByMeInMode(tde_provider_info_lock(), LW_EXCLUSIVE));

get_keyring_infofile_path(kp_info_path, record->database_id);
fd = BasicOpenFile(kp_info_path, O_CREAT | O_RDWR | PG_BINARY);
fd = OpenTransientFile(kp_info_path, O_CREAT | O_RDWR | PG_BINARY);
if (fd < 0)
{
ereport(ERROR,
Expand Down Expand Up @@ -638,20 +637,18 @@ write_key_provider_info(KeyringProviderRecordInFile *record, bool write_xlog)
record->offset_in_file);
if (bytes_written != sizeof(KeyringProviderRecord))
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("key provider info file \"%s\" can't be written: %m",
kp_info_path));
}
if (pg_fsync(fd) != 0)
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("could not fsync file \"%s\": %m", kp_info_path));
}
close(fd);
CloseTransientFile(fd);
}

/* Returns true if the record is found, false otherwise. */
Expand All @@ -678,15 +675,15 @@ get_keyring_info_file_record_by_name(char *provider_name, Oid database_id,
record->database_id = database_id;
record->offset_in_file = current_file_offset;
record->provider = existing_provider;
close(fd);
CloseTransientFile(fd);
return true;
}

current_file_offset = next_file_offset;
}

/* No matching key provider found */
close(fd);
CloseTransientFile(fd);
return false;
}

Expand Down Expand Up @@ -750,7 +747,7 @@ scan_key_provider_file(ProviderScanType scanType, void *scanKey, Oid dbOid)

LWLockAcquire(tde_provider_info_lock(), LW_SHARED);

fd = BasicOpenFile(kp_info_path, PG_BINARY);
fd = OpenTransientFile(kp_info_path, PG_BINARY);
if (fd < 0)
{
LWLockRelease(tde_provider_info_lock());
Expand Down Expand Up @@ -801,7 +798,7 @@ scan_key_provider_file(ProviderScanType scanType, void *scanKey, Oid dbOid)
}
}
}
close(fd);
CloseTransientFile(fd);
LWLockRelease(tde_provider_info_lock());
return providers_list;
}
Expand Down Expand Up @@ -994,7 +991,7 @@ open_keyring_infofile(Oid database_id, int flags)
char kp_info_path[MAXPGPATH];

get_keyring_infofile_path(kp_info_path, database_id);
fd = BasicOpenFile(kp_info_path, flags | PG_BINARY);
fd = OpenTransientFile(kp_info_path, flags | PG_BINARY);
if (fd < 0)
{
ereport(ERROR,
Expand Down Expand Up @@ -1022,7 +1019,6 @@ fetch_next_key_provider(int fd, off_t *curr_pos, KeyringProviderRecord *provider
return false;
if (bytes_read != sizeof(KeyringProviderRecord))
{
close(fd);
/* Corrupt file */
ereport(ERROR,
errcode_for_file_access(),
Expand Down
3 changes: 2 additions & 1 deletion contrib/pg_tde/src/include/pg_tde_fe.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ static int tde_fe_error_level = 0;
#define LW_EXCLUSIVE NULL
#define tde_lwlock_enc_keys() NULL

#define BasicOpenFile(fileName, fileFlags) open(fileName, fileFlags, PG_FILE_MODE_OWNER)
#define OpenTransientFile(fileName, fileFlags) open(fileName, fileFlags, PG_FILE_MODE_OWNER)
#define CloseTransientFile(fd) close(fd)
#define AllocateFile(name, mode) fopen(name, mode)
#define FreeFile(file) fclose(file)

Expand Down
20 changes: 9 additions & 11 deletions contrib/pg_tde/src/keyring/keyring_file.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ get_key_by_name(GenericKeyring *keyring, const char *key_name, KeyringReturnCode

*return_code = KEYRING_CODE_SUCCESS;

fd = BasicOpenFile(file_keyring->file_name, PG_BINARY);
fd = OpenTransientFile(file_keyring->file_name, PG_BINARY);
if (fd < 0)
return NULL;

Expand All @@ -69,13 +69,13 @@ get_key_by_name(GenericKeyring *keyring, const char *key_name, KeyringReturnCode
* Empty keyring file is considered as a valid keyring file that
* has no keys
*/
close(fd);
CloseTransientFile(fd);
pfree(key);
return NULL;
}
if (bytes_read != sizeof(KeyInfo))
{
close(fd);
CloseTransientFile(fd);
pfree(key);
/* Corrupt file */
*return_code = KEYRING_CODE_DATA_CORRUPTED;
Expand All @@ -88,11 +88,11 @@ get_key_by_name(GenericKeyring *keyring, const char *key_name, KeyringReturnCode
}
if (strncasecmp(key->name, key_name, sizeof(key->name)) == 0)
{
close(fd);
CloseTransientFile(fd);
return key;
}
}
close(fd);
CloseTransientFile(fd);
pfree(key);
return NULL;
}
Expand All @@ -116,7 +116,7 @@ set_key_by_name(GenericKeyring *keyring, KeyInfo *key)
errmsg("Key with name %s already exists in keyring", key->name));
}

fd = BasicOpenFile(file_keyring->file_name, O_CREAT | O_RDWR | PG_BINARY);
fd = OpenTransientFile(file_keyring->file_name, O_CREAT | O_RDWR | PG_BINARY);
if (fd < 0)
{
ereport(ERROR,
Expand All @@ -128,7 +128,6 @@ set_key_by_name(GenericKeyring *keyring, KeyInfo *key)
bytes_written = pg_pwrite(fd, key, sizeof(KeyInfo), curr_pos);
if (bytes_written != sizeof(KeyInfo))
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("keyring file \"%s\" can't be written: %m",
Expand All @@ -137,20 +136,19 @@ set_key_by_name(GenericKeyring *keyring, KeyInfo *key)

if (pg_fsync(fd) != 0)
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("could not fsync file \"%s\": %m",
file_keyring->file_name));
}
close(fd);
CloseTransientFile(fd);
}

static void
validate(GenericKeyring *keyring)
{
FileKeyring *file_keyring = (FileKeyring *) keyring;
int fd = BasicOpenFile(file_keyring->file_name, O_CREAT | O_RDWR | PG_BINARY);
int fd = OpenTransientFile(file_keyring->file_name, O_CREAT | O_RDWR | PG_BINARY);

if (fd < 0)
{
Expand All @@ -159,5 +157,5 @@ validate(GenericKeyring *keyring)
errmsg("Failed to open keyring file %s: %m", file_keyring->file_name));
}

close(fd);
CloseTransientFile(fd);
}