123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 |
- #include "HD.hh"
- #include "FileContext.hh"
- #include "FilePool.hh"
- #include "DeviceConfig.hh"
- #include "CliComm.hh"
- #include "HDImageCLI.hh"
- #include "MSXMotherBoard.hh"
- #include "Reactor.hh"
- #include "Display.hh"
- #include "GlobalSettings.hh"
- #include "MSXException.hh"
- #include "HDCommand.hh"
- #include "Timer.hh"
- #include "serialize.hh"
- #include "tiger.hh"
- #include "xrange.hh"
- #include <cassert>
- #include <memory>
- namespace openmsx {
- using std::string;
- HD::HD(const DeviceConfig& config)
- : motherBoard(config.getMotherBoard())
- , name("hdX")
- {
- hdInUse = motherBoard.getSharedStuff<HDInUse>("hdInUse");
- unsigned id = 0;
- while ((*hdInUse)[id]) {
- ++id;
- if (id == MAX_HD) {
- throw MSXException("Too many HDs");
- }
- }
- // for exception safety, set hdInUse only at the end
- name[2] = char('a' + id);
- // For the initial hd image, savestate should only try exactly this
- // (resolved) filename. For user-specified hd images (commandline or
- // via hda command) savestate will try to re-resolve the filename.
- auto mode = File::NORMAL;
- string cliImage = HDImageCLI::getImageForId(id);
- if (cliImage.empty()) {
- string original = config.getChildData("filename");
- string resolved = config.getFileContext().resolveCreate(original);
- filename = Filename(resolved);
- mode = File::CREATE;
- } else {
- filename = Filename(cliImage, userFileContext());
- }
- file = File(filename, mode);
- filesize = file.getSize();
- if (mode == File::CREATE && filesize == 0) {
- // OK, the file was just newly created. Now make sure the file
- // is of the right (default) size
- file.truncate(size_t(config.getChildDataAsInt("size")) * 1024 * 1024);
- filesize = file.getSize();
- }
- tigerTree = std::make_unique<TigerTree>(
- *this, filesize, filename.getResolved());
- (*hdInUse)[id] = true;
- hdCommand = std::make_unique<HDCommand>(
- motherBoard.getCommandController(),
- motherBoard.getStateChangeDistributor(),
- motherBoard.getScheduler(),
- *this,
- motherBoard.getReactor().getGlobalSettings().getPowerSetting());
- motherBoard.getMSXCliComm().update(CliComm::HARDWARE, name, "add");
- }
- HD::~HD()
- {
- motherBoard.getMSXCliComm().update(CliComm::HARDWARE, name, "remove");
- unsigned id = name[2] - 'a';
- assert((*hdInUse)[id]);
- (*hdInUse)[id] = false;
- }
- void HD::switchImage(const Filename& newFilename)
- {
- file = File(newFilename);
- filename = newFilename;
- filesize = file.getSize();
- tigerTree = std::make_unique<TigerTree>(*this, filesize,
- filename.getResolved());
- motherBoard.getMSXCliComm().update(CliComm::MEDIA, getName(),
- filename.getResolved());
- }
- size_t HD::getNbSectorsImpl() const
- {
- return filesize / sizeof(SectorBuffer);
- }
- void HD::readSectorImpl(size_t sector, SectorBuffer& buf)
- {
- file.seek(sector * sizeof(buf));
- file.read(&buf, sizeof(buf));
- }
- void HD::writeSectorImpl(size_t sector, const SectorBuffer& buf)
- {
- file.seek(sector * sizeof(buf));
- file.write(&buf, sizeof(buf));
- tigerTree->notifyChange(sector * sizeof(buf), sizeof(buf),
- file.getModificationDate());
- }
- bool HD::isWriteProtectedImpl() const
- {
- return file.isReadOnly();
- }
- Sha1Sum HD::getSha1SumImpl(FilePool& filePool)
- {
- if (hasPatches()) {
- return SectorAccessibleDisk::getSha1SumImpl(filePool);
- }
- return filePool.getSha1Sum(file);
- }
- void HD::showProgress(size_t position, size_t maxPosition)
- {
- // only show progress iff:
- // - 1 second has passed since last progress OR
- // - we reach completion and did progress before (to show the 100%)
- // This avoids showing any progress if the operation would take less than 1 second.
- auto now = Timer::getTime();
- if (((now - lastProgressTime) > 1000000) ||
- ((position == maxPosition) && everDidProgress)) {
- lastProgressTime = now;
- int percentage = int((100 * position) / maxPosition);
- motherBoard.getMSXCliComm().printProgress(
- "Calculating hash for ", filename.getResolved(),
- "... ", percentage, '%');
- motherBoard.getReactor().getDisplay().repaintDelayed(0);
- everDidProgress = true;
- }
- }
- std::string HD::getTigerTreeHash()
- {
- lastProgressTime = Timer::getTime();
- everDidProgress = false;
- auto callback = [this](size_t p, size_t t) { showProgress(p, t); };
- return tigerTree->calcHash(callback).toString(); // calls HD::getData()
- }
- uint8_t* HD::getData(size_t offset, size_t size)
- {
- assert(size <= 1024);
- assert((offset % sizeof(SectorBuffer)) == 0);
- assert((size % sizeof(SectorBuffer)) == 0);
- struct Work {
- char extra; // at least one byte before 'bufs'
- // likely here are padding bytes inbetween
- SectorBuffer bufs[1024 / sizeof(SectorBuffer)];
- };
- static Work work; // not reentrant
- size_t sector = offset / sizeof(SectorBuffer);
- for (auto i : xrange(size / sizeof(SectorBuffer))) {
- // This possibly applies IPS patches.
- readSector(sector++, work.bufs[i]);
- }
- return work.bufs[0].raw;
- }
- bool HD::isCacheStillValid(time_t& cacheTime)
- {
- time_t fileTime = file.getModificationDate();
- bool result = fileTime == cacheTime;
- cacheTime = fileTime;
- return result;
- }
- SectorAccessibleDisk* HD::getSectorAccessibleDisk()
- {
- return this;
- }
- const std::string& HD::getContainerName() const
- {
- return getName();
- }
- bool HD::diskChanged()
- {
- return false; // TODO not implemented
- }
- int HD::insertDisk(std::string_view newFilename)
- {
- try {
- switchImage(Filename(string(newFilename)));
- return 0;
- } catch (MSXException&) {
- return -1;
- }
- }
- // version 1: initial version
- // version 2: replaced 'checksum'(=sha1) with 'tthsum`
- template<typename Archive>
- void HD::serialize(Archive& ar, unsigned version)
- {
- Filename tmp = file.is_open() ? filename : Filename();
- ar.serialize("filename", tmp);
- if (ar.isLoader()) {
- if (tmp.empty()) {
- // Lazily open file specified in config. And close if
- // it was already opened (in the constructor). The
- // latter can occur in the following scenario:
- // - The hd image doesn't exist yet
- // - Reverse creates savestates, these still have
- // tmp="" (because file=nullptr)
- // - At some later point the hd image gets created
- // (e.g. on first access to the image)
- // - Now reverse to some point in EmuTime before the
- // first disk access
- // - The loadstate re-constructs this HD object, but
- // because the hd image does exist now, it gets
- // opened in the constructor (file!=nullptr).
- // - So to get in the same state as the initial
- // savestate we again close the file. Otherwise the
- // checksum-check code below goes wrong.
- file.close();
- } else {
- tmp.updateAfterLoadState();
- if (filename != tmp) switchImage(tmp);
- assert(file.is_open());
- }
- }
- // store/check checksum
- if (file.is_open()) {
- bool mismatch = false;
- if (ar.versionAtLeast(version, 2)) {
- // use tiger-tree-hash
- string oldTiger = ar.isLoader() ? string{} : getTigerTreeHash();
- ar.serialize("tthsum", oldTiger);
- if (ar.isLoader()) {
- string newTiger = getTigerTreeHash();
- mismatch = oldTiger != newTiger;
- }
- } else {
- // use sha1
- auto& filepool = motherBoard.getReactor().getFilePool();
- Sha1Sum oldChecksum;
- if (!ar.isLoader()) {
- oldChecksum = getSha1Sum(filepool);
- }
- string oldChecksumStr = oldChecksum.empty()
- ? string{}
- : oldChecksum.toString();
- ar.serialize("checksum", oldChecksumStr);
- oldChecksum = oldChecksumStr.empty()
- ? Sha1Sum()
- : Sha1Sum(oldChecksumStr);
- if (ar.isLoader()) {
- Sha1Sum newChecksum = getSha1Sum(filepool);
- mismatch = oldChecksum != newChecksum;
- }
- }
- if (ar.isLoader() && mismatch) {
- motherBoard.getMSXCliComm().printWarning(
- "The content of the harddisk ",
- tmp.getResolved(),
- " has changed since the time this savestate was "
- "created. This might result in emulation problems "
- "or even diskcorruption. To prevent the latter, "
- "the harddisk is now write-protected.");
- forceWriteProtect();
- }
- }
- }
- INSTANTIATE_SERIALIZE_METHODS(HD);
- } // namespace openmsx
|