feat: implement M5 reliable saves and recovery

This commit is contained in:
2026-09-12 14:08:33 +08:00
parent e91de54bad
commit 8899219333
26 changed files with 1389 additions and 47 deletions
@@ -4,8 +4,16 @@
#include "session_rules.h"
#include "timing_metrics.h"
#include "video_buffer.h"
#include "safe_commit.h"
#include "save_package.h"
#include "save_policy.h"
#include "save_state.h"
#include "sha256.h"
#include <cmath>
#include <filesystem>
#include <fstream>
#include <vector>
int main() {
using neslite::SessionState;
@@ -99,5 +107,90 @@ int main() {
previous_pal = gate;
}
if (ntsc_pulses != 15 || pal_pulses != 15 || neslite::turbo_gate(-1.0)) return 40;
const std::vector<std::uint8_t> abc = {'a', 'b', 'c'};
if (neslite::sha256_hex(abc) != "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad") return 41;
const auto test_root = std::filesystem::current_path() / "neslite-save-tests";
std::error_code file_error;
std::filesystem::remove_all(test_root, file_error);
std::filesystem::create_directories(test_root, file_error);
if (file_error) return 42;
neslite::SafeCommitter committer;
const auto destination = test_root / "rom" / "battery.sav";
const std::vector<std::uint8_t> first = {1, 2, 3};
const std::vector<std::uint8_t> second = {4, 5, 6, 7};
const std::vector<std::uint8_t> older = {9};
if (committer.commit("rom", destination, first, 1) != neslite::CommitResult::Committed) return 43;
if (committer.commit("rom", destination, second, 2, {.fail_before_replace = true}) !=
neslite::CommitResult::InjectedFailure) return 44;
std::ifstream preserved(destination, std::ios::binary);
const std::vector<std::uint8_t> preserved_bytes((std::istreambuf_iterator<char>(preserved)), {});
if (preserved_bytes != first) return 45;
preserved.close();
if (committer.commit("rom", destination, second, 3) != neslite::CommitResult::Committed) return 46;
if (committer.commit("rom", destination, older, 2) != neslite::CommitResult::Superseded) return 47;
std::ifstream current(destination, std::ios::binary);
const std::vector<std::uint8_t> current_bytes((std::istreambuf_iterator<char>(current)), {});
if (current_bytes != second) return 48;
current.close();
std::ifstream backup(destination.string() + ".bak", std::ios::binary);
const std::vector<std::uint8_t> backup_bytes((std::istreambuf_iterator<char>(backup)), {});
if (backup_bytes != first) return 49;
backup.close();
neslite::SaveStateMetadata metadata{
.rom_hash = std::string(64, 'a'),
.core_name = "FCEUmm",
.core_commit = "236ccdf",
.configuration = "region=auto",
.created_epoch_ms = 123456,
.thumbnail_width = 2,
.thumbnail_height = 1,
.thumbnail_pitch = 4,
.thumbnail_pixel_format = 2,
};
const std::vector<std::uint8_t> state = {10, 20, 30, 40};
const std::vector<std::uint8_t> thumbnail = {1, 2, 3, 4};
const auto envelope = neslite::encode_save_state(metadata, state, thumbnail);
neslite::DecodedSaveState decoded;
std::string decode_error;
if (!neslite::decode_save_state(envelope, &decoded, &decode_error) || decoded.state != state ||
decoded.thumbnail != thumbnail || decoded.metadata.created_epoch_ms != 123456) return 50;
auto truncated = envelope;
truncated.pop_back();
if (neslite::decode_save_state(truncated, &decoded, &decode_error) || decode_error != "payload_length") return 51;
auto corrupted = envelope;
corrupted[corrupted.size() - thumbnail.size() - 1U] ^= 0xffU;
if (neslite::decode_save_state(corrupted, &decoded, &decode_error) || decode_error != "checksum") return 52;
if (!neslite::save_state_compatible(metadata, metadata.rom_hash, "FCEUmm", "236ccdf", "region=auto", &decode_error)) return 53;
if (neslite::save_state_compatible(metadata, std::string(64, 'b'), "FCEUmm", "236ccdf", "region=auto", &decode_error) ||
decode_error != "rom_hash") return 54;
if (neslite::save_state_compatible(metadata, metadata.rom_hash, "FCEUmm", "other", "region=auto", &decode_error) ||
decode_error != "core_commit") return 55;
neslite::SaveSchedule schedule(10.0, 60.0);
schedule.advance(9.9);
if (schedule.take_battery_due() || schedule.take_auto_due()) return 56;
schedule.advance(0.1);
if (!schedule.take_battery_due() || schedule.take_battery_due()) return 57;
schedule.advance(50.0);
if (!schedule.take_battery_due() || !schedule.take_auto_due()) return 58;
if (neslite::auto_slot_for_generation(0) != 0 || neslite::auto_slot_for_generation(3) != 0 ||
neslite::auto_slot_for_generation(4) != 1) return 59;
const std::vector<neslite::SavePackageEntry> entries = {
{"battery/battery.sav", first}, {"states/slot-0.nls", envelope},
};
const auto package_bytes = neslite::encode_save_package(metadata.rom_hash, entries);
neslite::DecodedSavePackage decoded_package;
if (!neslite::decode_save_package(package_bytes, &decoded_package, &decode_error) ||
decoded_package.entries.size() != 2U || decoded_package.entries[1].bytes != envelope) return 60;
if (neslite::package_path_allowed("../rom.nes") || neslite::package_path_allowed("states/slot-10.nls")) return 61;
auto bad_package = package_bytes;
bad_package.back() ^= 0xffU;
if (neslite::decode_save_package(bad_package, &decoded_package, &decode_error) ||
decode_error != "entry_checksum") return 62;
std::filesystem::remove_all(test_root, file_error);
return 0;
}