Reduce ESP ACL save metadata opens while preserving verified recovery
This commit is contained in:
1 parent
3f1252af28
commit
0e25a1f15e
6 files changed
+494
-51
No files matched your search
@@ -1,16 +1,44 @@
|
||||
#pragma once
|
||||
|
||||
#if defined(ESP32_PLATFORM)
|
||||
#include "FilePresence.h"
|
||||
#endif
|
||||
|
||||
namespace mesh {
|
||||
|
||||
static const char CLIENT_ACL_PRIMARY_PATH[] = "/s_contacts";
|
||||
static const char CLIENT_ACL_TEMP_PATH[] = "/s_contacts.tmp";
|
||||
static const char CLIENT_ACL_BACKUP_PATH[] = "/s_contacts.bak";
|
||||
|
||||
// ESP ACL stores are mounted at /spiffs. Unlike FS::exists(), the metadata
|
||||
// probe does not open/close the file and distinguishes absent from unreadable.
|
||||
template <typename Filesystem>
|
||||
bool clientACLFilePresence(Filesystem* fs, const char* path, bool& present) {
|
||||
#if defined(ESP32_PLATFORM)
|
||||
return filePresence(fs, path, present);
|
||||
#else
|
||||
present = fs->exists(path);
|
||||
return true;
|
||||
#endif
|
||||
}
|
||||
|
||||
enum class ClientACLFileValidation { Invalid, Valid, MetadataError };
|
||||
|
||||
inline ClientACLFileValidation clientACLValidation(bool valid) {
|
||||
return valid ? ClientACLFileValidation::Valid
|
||||
: ClientACLFileValidation::Invalid;
|
||||
}
|
||||
inline ClientACLFileValidation clientACLValidation(ClientACLFileValidation valid) {
|
||||
return valid;
|
||||
}
|
||||
|
||||
template <typename Filesystem>
|
||||
bool removeClientACLArtifact(Filesystem* fs, const char* path) {
|
||||
if (!fs->exists(path)) return true;
|
||||
bool present;
|
||||
if (!clientACLFilePresence(fs, path, present)) return false;
|
||||
if (!present) return true;
|
||||
fs->remove(path);
|
||||
return !fs->exists(path);
|
||||
return clientACLFilePresence(fs, path, present) && !present;
|
||||
}
|
||||
|
||||
// Recover the last published image after any power-loss boundary in the
|
||||
@@ -18,7 +46,9 @@ bool removeClientACLArtifact(Filesystem* fs, const char* path) {
|
||||
// if publication had not completed, the backup is restored instead.
|
||||
template <typename Filesystem>
|
||||
bool recoverClientACLFiles(Filesystem* fs) {
|
||||
if (fs->exists(CLIENT_ACL_PRIMARY_PATH)) {
|
||||
bool primary_exists, backup_exists;
|
||||
if (!clientACLFilePresence(fs, CLIENT_ACL_PRIMARY_PATH, primary_exists)) return false;
|
||||
if (primary_exists) {
|
||||
// The primary is already authoritative. Cleanup is best-effort: a
|
||||
// filesystem which cannot remove a stale artifact must not make the
|
||||
// committed image appear unavailable.
|
||||
@@ -26,7 +56,8 @@ bool recoverClientACLFiles(Filesystem* fs) {
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_BACKUP_PATH);
|
||||
return true;
|
||||
}
|
||||
if (fs->exists(CLIENT_ACL_BACKUP_PATH)) {
|
||||
if (!clientACLFilePresence(fs, CLIENT_ACL_BACKUP_PATH, backup_exists)) return false;
|
||||
if (backup_exists) {
|
||||
if (!fs->rename(CLIENT_ACL_BACKUP_PATH, CLIENT_ACL_PRIMARY_PATH)) {
|
||||
return false;
|
||||
}
|
||||
@@ -38,25 +69,33 @@ bool recoverClientACLFiles(Filesystem* fs) {
|
||||
|
||||
template <typename Filesystem, typename Validator>
|
||||
bool recoverClientACLFilesVerified(Filesystem* fs, Validator is_valid) {
|
||||
if (fs->exists(CLIENT_ACL_PRIMARY_PATH)
|
||||
&& is_valid(fs, CLIENT_ACL_PRIMARY_PATH)) {
|
||||
// A validated primary remains authoritative even when stale-artifact
|
||||
// cleanup is temporarily unavailable.
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_TEMP_PATH);
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_BACKUP_PATH);
|
||||
return true;
|
||||
}
|
||||
if (fs->exists(CLIENT_ACL_BACKUP_PATH)
|
||||
&& is_valid(fs, CLIENT_ACL_BACKUP_PATH)) {
|
||||
if (!removeClientACLArtifact(fs, CLIENT_ACL_PRIMARY_PATH)
|
||||
|| !fs->rename(CLIENT_ACL_BACKUP_PATH, CLIENT_ACL_PRIMARY_PATH)) {
|
||||
return false;
|
||||
bool primary_exists, backup_exists;
|
||||
if (!clientACLFilePresence(fs, CLIENT_ACL_PRIMARY_PATH, primary_exists)) return false;
|
||||
if (primary_exists) {
|
||||
const auto result = clientACLValidation(is_valid(fs, CLIENT_ACL_PRIMARY_PATH));
|
||||
if (result == ClientACLFileValidation::MetadataError) return false;
|
||||
if (result == ClientACLFileValidation::Valid) {
|
||||
// A validated primary remains authoritative even when stale-artifact
|
||||
// cleanup is temporarily unavailable.
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_TEMP_PATH);
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_BACKUP_PATH);
|
||||
return true;
|
||||
}
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_TEMP_PATH);
|
||||
return true;
|
||||
}
|
||||
return !fs->exists(CLIENT_ACL_PRIMARY_PATH)
|
||||
&& !fs->exists(CLIENT_ACL_BACKUP_PATH)
|
||||
if (!clientACLFilePresence(fs, CLIENT_ACL_BACKUP_PATH, backup_exists)) return false;
|
||||
if (backup_exists) {
|
||||
const auto result = clientACLValidation(is_valid(fs, CLIENT_ACL_BACKUP_PATH));
|
||||
if (result == ClientACLFileValidation::MetadataError) return false;
|
||||
if (result == ClientACLFileValidation::Valid) {
|
||||
if (!removeClientACLArtifact(fs, CLIENT_ACL_PRIMARY_PATH)
|
||||
|| !fs->rename(CLIENT_ACL_BACKUP_PATH, CLIENT_ACL_PRIMARY_PATH)) {
|
||||
return false;
|
||||
}
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_TEMP_PATH);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return !primary_exists && !backup_exists
|
||||
&& removeClientACLArtifact(fs, CLIENT_ACL_TEMP_PATH);
|
||||
}
|
||||
|
||||
@@ -66,9 +105,11 @@ bool publishVerifiedClientACLTemp(Filesystem* fs, bool temp_verified) {
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_TEMP_PATH);
|
||||
return false;
|
||||
}
|
||||
if (fs->exists(CLIENT_ACL_BACKUP_PATH)) return false;
|
||||
bool backup_exists, had_primary;
|
||||
if (!clientACLFilePresence(fs, CLIENT_ACL_BACKUP_PATH, backup_exists)
|
||||
|| backup_exists
|
||||
|| !clientACLFilePresence(fs, CLIENT_ACL_PRIMARY_PATH, had_primary)) return false;
|
||||
|
||||
const bool had_primary = fs->exists(CLIENT_ACL_PRIMARY_PATH);
|
||||
if (had_primary
|
||||
&& !fs->rename(CLIENT_ACL_PRIMARY_PATH, CLIENT_ACL_BACKUP_PATH)) {
|
||||
return false;
|
||||
@@ -76,7 +117,9 @@ bool publishVerifiedClientACLTemp(Filesystem* fs, bool temp_verified) {
|
||||
if (!fs->rename(CLIENT_ACL_TEMP_PATH, CLIENT_ACL_PRIMARY_PATH)) {
|
||||
// Restore the last committed image immediately when possible. If this
|
||||
// rename also fails, leave both artifacts for recoverClientACLFiles().
|
||||
if (had_primary && !fs->exists(CLIENT_ACL_PRIMARY_PATH)) {
|
||||
bool primary_exists;
|
||||
if (had_primary && clientACLFilePresence(fs, CLIENT_ACL_PRIMARY_PATH, primary_exists)
|
||||
&& !primary_exists) {
|
||||
fs->rename(CLIENT_ACL_BACKUP_PATH, CLIENT_ACL_PRIMARY_PATH);
|
||||
}
|
||||
return false;
|
||||
@@ -95,16 +138,18 @@ bool publishVerifiedClientACLTemp(Filesystem* fs, bool temp_verified,
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_TEMP_PATH);
|
||||
return false;
|
||||
}
|
||||
if (fs->exists(CLIENT_ACL_BACKUP_PATH)) return false;
|
||||
const bool had_primary = fs->exists(CLIENT_ACL_PRIMARY_PATH);
|
||||
bool backup_exists, had_primary;
|
||||
if (!clientACLFilePresence(fs, CLIENT_ACL_BACKUP_PATH, backup_exists)
|
||||
|| backup_exists
|
||||
|| !clientACLFilePresence(fs, CLIENT_ACL_PRIMARY_PATH, had_primary)) return false;
|
||||
if (had_primary
|
||||
&& !fs->rename(CLIENT_ACL_PRIMARY_PATH, CLIENT_ACL_BACKUP_PATH)) {
|
||||
return false;
|
||||
}
|
||||
if (!fs->rename(CLIENT_ACL_TEMP_PATH, CLIENT_ACL_PRIMARY_PATH)
|
||||
|| !is_valid(fs, CLIENT_ACL_PRIMARY_PATH)) {
|
||||
removeClientACLArtifact(fs, CLIENT_ACL_PRIMARY_PATH);
|
||||
if (had_primary) {
|
||||
|| clientACLValidation(is_valid(fs, CLIENT_ACL_PRIMARY_PATH))
|
||||
!= ClientACLFileValidation::Valid) {
|
||||
if (removeClientACLArtifact(fs, CLIENT_ACL_PRIMARY_PATH) && had_primary) {
|
||||
fs->rename(CLIENT_ACL_BACKUP_PATH, CLIENT_ACL_PRIMARY_PATH);
|
||||
}
|
||||
return false;
|
||||
|
||||
Reference in new issue
Block a user