From f67d51cb375d7f3d9dbd5caaaf00775c08dd7bcd Mon Sep 17 00:00:00 2001 From: Alex Barney Date: Sun, 9 May 2021 21:45:54 -0700 Subject: [PATCH] Add save data extra data functions to SaveDataFileSystemServiceImpl Adds ReadSaveDataFileSystemExtraData and WriteSaveDataFileSystemExtraData Auto-format SaveDataFileSystemServiceImpl Use SdkRecursiveMutexType instead of SdkRecursiveMutex in SaveDataExtraDataAccessorCacheManager --- .../SaveDataExtraDataAccessorCacheManager.cs | 14 +- .../FsSrv/SaveDataFileSystemServiceImpl.cs | 140 +++++++++++++++--- .../SaveDataFileSystemCacheManager.cs | 5 + 3 files changed, 134 insertions(+), 25 deletions(-) diff --git a/src/LibHac/FsSrv/Impl/SaveDataExtraDataAccessorCacheManager.cs b/src/LibHac/FsSrv/Impl/SaveDataExtraDataAccessorCacheManager.cs index dabe0f0b..ff723420 100644 --- a/src/LibHac/FsSrv/Impl/SaveDataExtraDataAccessorCacheManager.cs +++ b/src/LibHac/FsSrv/Impl/SaveDataExtraDataAccessorCacheManager.cs @@ -37,12 +37,12 @@ namespace LibHac.FsSrv.Impl } private readonly LinkedList _accessorList; - private SdkRecursiveMutex _mutex; + private SdkRecursiveMutexType _mutex; public SaveDataExtraDataAccessorCacheManager() { _accessorList = new LinkedList(); - _mutex = new SdkRecursiveMutex(); + _mutex.Initialize(); } public void Dispose() @@ -55,7 +55,7 @@ namespace LibHac.FsSrv.Impl { var cache = new Cache(accessor, spaceId, saveDataId); - using ScopedLock scopedLock = ScopedLock.Lock(ref _mutex); + using ScopedLock scopedLock = ScopedLock.Lock(ref _mutex); _accessorList.AddLast(cache); return Result.Success; @@ -63,7 +63,7 @@ namespace LibHac.FsSrv.Impl public void Unregister(SaveDataSpaceId spaceId, ulong saveDataId) { - using ScopedLock scopedLock = ScopedLock.Lock(ref _mutex); + using ScopedLock scopedLock = ScopedLock.Lock(ref _mutex); UnregisterImpl(spaceId, saveDataId); } @@ -89,7 +89,7 @@ namespace LibHac.FsSrv.Impl { UnsafeHelpers.SkipParamInit(out accessor); - using ScopedLock scopedLock = ScopedLock.Lock(ref _mutex); + using ScopedLock scopedLock = ScopedLock.Lock(ref _mutex); LinkedListNode currentNode = _accessorList.First; @@ -126,9 +126,9 @@ namespace LibHac.FsSrv.Impl } } - public ScopedLock GetScopedLock() + public ScopedLock GetScopedLock() { - return new ScopedLock(ref _mutex); + return new ScopedLock(ref _mutex); } } } \ No newline at end of file diff --git a/src/LibHac/FsSrv/SaveDataFileSystemServiceImpl.cs b/src/LibHac/FsSrv/SaveDataFileSystemServiceImpl.cs index c9716ebb..e96dec13 100644 --- a/src/LibHac/FsSrv/SaveDataFileSystemServiceImpl.cs +++ b/src/LibHac/FsSrv/SaveDataFileSystemServiceImpl.cs @@ -30,12 +30,12 @@ namespace LibHac.FsSrv private class TimeStampGetter : ISaveDataCommitTimeStampGetter { private SaveDataFileSystemServiceImpl _saveService; - + public TimeStampGetter(SaveDataFileSystemServiceImpl saveService) { _saveService = saveService; } - + public Result Get(out long timeStamp) { return _saveService.GetSaveDataCommitTimeStamp(out timeStamp); @@ -165,8 +165,8 @@ namespace LibHac.FsSrv ReferenceCountedDisposable extraDataAccessor = null; try { - using ScopedLock scopedLock = _extraDataCacheManager.GetScopedLock(); - + using ScopedLock scopedLock = _extraDataCacheManager.GetScopedLock(); + // Todo: Update ISaveDataFileSystemCreator bool useDeviceUniqueMac = IsDeviceUniqueMac(spaceId); @@ -217,8 +217,8 @@ namespace LibHac.FsSrv var metaDirPath = // /saveMeta/ new U8Span(new[] { - (byte) '/', (byte) 's', (byte) 'a', (byte) 'v', (byte) 'e', (byte) 'M', (byte) 'e', (byte) 't', - (byte) 'a', (byte) '/' + (byte)'/', (byte)'s', (byte)'a', (byte)'v', (byte)'e', (byte)'M', (byte)'e', (byte)'t', + (byte)'a', (byte)'/' }); Span directoryName = stackalloc byte[0x1B]; @@ -287,8 +287,8 @@ namespace LibHac.FsSrv var metaDirPath = // /saveMeta new U8Span(new[] { - (byte) '/', (byte) 's', (byte) 'a', (byte) 'v', (byte) 'e', (byte) 'M', (byte) 'e', (byte) 't', - (byte) 'a' + (byte)'/', (byte)'s', (byte)'a', (byte)'v', (byte)'e', (byte)'M', (byte)'e', (byte)'t', + (byte)'a' }); ReferenceCountedDisposable fileSystem = null; @@ -383,7 +383,7 @@ namespace LibHac.FsSrv try { _saveDataFsCacheManager.Unregister(spaceId, saveDataId); - + // Open the directory containing the save data Result rc = OpenSaveDataDirectoryFileSystem(out fileSystem, spaceId, saveDataRootPath, false); if (rc.IsFailure()) return rc; @@ -427,15 +427,115 @@ namespace LibHac.FsSrv public Result ReadSaveDataFileSystemExtraData(out SaveDataExtraData extraData, SaveDataSpaceId spaceId, ulong saveDataId, SaveDataType type, U8Span saveDataRootPath) { - // Todo: Find a way to store extra data for directory save data - extraData = new SaveDataExtraData(); - return Result.Success; + UnsafeHelpers.SkipParamInit(out extraData); + + // Nintendo returns blank extra data for directory save data. + // We've extended directory save data to store extra data so we don't need to do that. + + using ScopedLock scopedLockFsCache = _saveDataFsCacheManager.GetScopedLock(); + using ScopedLock scopedLockExtraDataCache = _extraDataCacheManager.GetScopedLock(); + + ReferenceCountedDisposable extraDataAccessor = null; + try + { + // Try to grab an extra data accessor for the requested save from the cache. + Result rc = _extraDataCacheManager.GetCache(out extraDataAccessor, spaceId, saveDataId); + + if (rc.IsSuccess()) + { + // An extra data accessor was found in the cache. Read the extra data from it. + return extraDataAccessor.Target.ReadExtraData(out extraData); + } + + ReferenceCountedDisposable unusedSaveDataFs = null; + try + { + // We won't actually use the returned save data FS. + // Opening the FS should cache an extra data accessor for it. + rc = OpenSaveDataFileSystem(out unusedSaveDataFs, spaceId, saveDataId, saveDataRootPath, + openReadOnly: true, type, cacheExtraData: true); + if (rc.IsFailure()) return rc; + + // Try to grab an accessor from the cache again. + rc = _extraDataCacheManager.GetCache(out extraDataAccessor, spaceId, saveDataId); + + if (rc.IsFailure()) + { + // No extra data accessor was registered for the requested save data. + // Return a blank extra data struct. + extraData = new SaveDataExtraData(); + return rc; + } + + return extraDataAccessor.Target.ReadExtraData(out extraData); + } + finally + { + unusedSaveDataFs?.Dispose(); + } + } + finally + { + extraDataAccessor?.Dispose(); + } } public Result WriteSaveDataFileSystemExtraData(SaveDataSpaceId spaceId, ulong saveDataId, in SaveDataExtraData extraData, U8Span saveDataRootPath, SaveDataType type, bool updateTimeStamp) { - throw new NotImplementedException(); + // Nintendo does nothing when writing directory save data extra data. + // We've extended directory save data to store extra data so we don't return early. + + using ScopedLock scopedLockFsCache = _saveDataFsCacheManager.GetScopedLock(); + using ScopedLock scopedLockExtraDataCache = _extraDataCacheManager.GetScopedLock(); + + ReferenceCountedDisposable extraDataAccessor = null; + try + { + // Try to grab an extra data accessor for the requested save from the cache. + Result rc = _extraDataCacheManager.GetCache(out extraDataAccessor, spaceId, saveDataId); + + if (rc.IsFailure()) + { + // No accessor was found in the cache. Try to open one. + ReferenceCountedDisposable unusedSaveDataFs = null; + try + { + // We won't actually use the returned save data FS. + // Opening the FS should cache an extra data accessor for it. + rc = OpenSaveDataFileSystem(out unusedSaveDataFs, spaceId, saveDataId, saveDataRootPath, + openReadOnly: false, type, cacheExtraData: true); + if (rc.IsFailure()) return rc; + + // Try to grab an accessor from the cache again. + rc = _extraDataCacheManager.GetCache(out extraDataAccessor, spaceId, saveDataId); + + if (rc.IsFailure()) + { + // No extra data accessor was registered for the requested save data, so don't do anything. + return rc; + } + } + finally + { + unusedSaveDataFs?.Dispose(); + } + } + + // We should have a valid accessor if we've reached this point. + // Write and commit the extra data. + rc = extraDataAccessor.Target.WriteExtraData(in extraData); + if (rc.IsFailure()) return rc; + + rc = extraDataAccessor.Target.CommitExtraData(updateTimeStamp); + if (rc.IsFailure()) return rc; + + return Result.Success; + } + finally + { + extraDataAccessor?.Dispose(); + } } public Result CorruptSaveDataFileSystem(SaveDataSpaceId spaceId, ulong saveDataId, long offset, @@ -527,14 +627,16 @@ namespace LibHac.FsSrv switch (spaceId) { case SaveDataSpaceId.System: - rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, BisPartitionId.System, true); + rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, BisPartitionId.System, + true); if (rc.IsFailure()) return rc; return Utility.WrapSubDirectory(out fileSystem, ref tempFs, basePath, createIfMissing); case SaveDataSpaceId.User: case SaveDataSpaceId.Temporary: - rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, BisPartitionId.User, true); + rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, BisPartitionId.User, + true); if (rc.IsFailure()) return rc; return Utility.WrapSubDirectory(out fileSystem, ref tempFs, basePath, createIfMissing); @@ -558,13 +660,15 @@ namespace LibHac.FsSrv in _encryptionSeed); case SaveDataSpaceId.ProperSystem: - rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, BisPartitionId.SystemProperPartition, true); + rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, + BisPartitionId.SystemProperPartition, true); if (rc.IsFailure()) return rc; return Utility.WrapSubDirectory(out fileSystem, ref tempFs, basePath, createIfMissing); case SaveDataSpaceId.SafeMode: - rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, BisPartitionId.SafeMode, true); + rc = _config.BaseFsService.OpenBisFileSystem(out tempFs, U8Span.Empty, BisPartitionId.SafeMode, + true); if (rc.IsFailure()) return rc; return Utility.WrapSubDirectory(out fileSystem, ref tempFs, basePath, createIfMissing); @@ -689,4 +793,4 @@ namespace LibHac.FsSrv _config.SaveIndexerManager.ResetIndexer(SaveDataSpaceId.Temporary); } } -} +} \ No newline at end of file diff --git a/src/LibHac/FsSystem/SaveDataFileSystemCacheManager.cs b/src/LibHac/FsSystem/SaveDataFileSystemCacheManager.cs index 77a92c4d..f34b1029 100644 --- a/src/LibHac/FsSystem/SaveDataFileSystemCacheManager.cs +++ b/src/LibHac/FsSystem/SaveDataFileSystemCacheManager.cs @@ -155,5 +155,10 @@ namespace LibHac.FsSystem } } } + + public ScopedLock GetScopedLock() + { + return new ScopedLock(ref _mutex); + } } } \ No newline at end of file