Mirror/LibHac
1
0
Fork 0
mirror of https://github.com/Thealexbarney/LibHac.git synced 2025-02-09 13:14:46 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Make IStorage an abstract class

Browse Source
This commit is contained in:
Alex Barney 2020-06-13 00:37:21 -07:00
parent 106c36492b
commit 395fabd171
26 changed files with 255 additions and 244 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/LibHac/Fs/FileHandleStorage.cs
View File

@ -2,7 +2,7 @@
namespace LibHac.Fs
{
public class FileHandleStorage : StorageBase
public class FileHandleStorage : IStorage
{
private const long InvalidSize = -1;
private readonly object _locker = new object();
@ -21,7 +21,7 @@ namespace LibHac.Fs
FsClient = Handle.File.Parent.FsClient;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
lock (_locker)
{
@ -36,7 +36,7 @@ namespace LibHac.Fs
}
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
lock (_locker)
{
@ -51,19 +51,19 @@ namespace LibHac.Fs
}
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return FsClient.FlushFile(Handle);
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
FileSize = InvalidSize;
return FsClient.SetFileSize(Handle, size);
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = default;

14
src/LibHac/Fs/FileStorage2.cs
View File

@ -5,7 +5,7 @@ using LibHac.Fs.Fsa;
namespace LibHac.Fs
{
public class FileStorage2 : StorageBase
public class FileStorage2 : IStorage
{
protected const long SizeNotInitialized = -1;
@ -40,7 +40,7 @@ namespace LibHac.Fs
return Result.Success;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
if (destination.Length == 0)
return Result.Success;
@ -54,7 +54,7 @@ namespace LibHac.Fs
return BaseFile.Read(out _, offset, destination, ReadOption.None);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
if (source.Length == 0)
return Result.Success;
@ -68,12 +68,12 @@ namespace LibHac.Fs
return BaseFile.Write(offset, source, WriteOption.None);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseFile.Flush();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
Result rc = UpdateSize();
if (rc.IsFailure())
@ -86,13 +86,13 @@ namespace LibHac.Fs
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
FileSize = SizeNotInitialized;
return BaseFile.SetSize(size);
}
protected override Result OperateRangeImpl(Span<byte> outBuffer, OperationId operationId, long offset, long size, ReadOnlySpan<byte> inBuffer)
protected override Result DoOperateRange(Span<byte> outBuffer, OperationId operationId, long offset, long size, ReadOnlySpan<byte> inBuffer)
{
switch (operationId)
{

136
src/LibHac/Fs/IStorage.cs
View File

@ -1,47 +1,97 @@
using System;
using System.Runtime.CompilerServices;
using System.Threading;
namespace LibHac.Fs
{
// ReSharper disable once InconsistentNaming
/// <summary>
/// Provides an interface for reading and writing a sequence of bytes.
/// </summary>
public interface IStorage : IDisposable
/// <remarks>
/// The official IStorage makes the <c>Read</c> etc. methods abstract and doesn't
/// have <c>DoRead</c> etc. methods. We're using them here so we can make sure
/// the object isn't disposed before calling the method implementation.
/// </remarks>
public abstract class IStorage : IDisposable
{
// 0 = not disposed; 1 = disposed
private int _disposedState;
private bool IsDisposed => _disposedState != 0;
/// <summary>
/// Reads a sequence of bytes from the current <see cref="IStorage"/>.
/// </summary>
/// <param name="offset">The offset in the <see cref="IStorage"/> at which to begin reading.</param>
/// <param name="destination">The buffer where the read bytes will be stored.
/// The number of bytes read will be equal to the length of the buffer.</param>
/// <param name="offset">The offset in the <see cref="IStorage"/> at which to begin reading.</param>
/// <exception cref="ArgumentException">Invalid offset or the IStorage contains fewer bytes than requested. </exception>
Result Read(long offset, Span<byte> destination);
/// <returns>The <see cref="Result"/> of the operation.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Result Read(long offset, Span<byte> destination)
{
if (IsDisposed)
return ResultFs.PreconditionViolation.Log();
return DoRead(offset, destination);
}
/// <summary>
/// Writes a sequence of bytes to the current <see cref="IStorage"/>.
/// </summary>
/// <param name="source">The buffer containing the bytes to be written.</param>
/// <param name="offset">The offset in the <see cref="IStorage"/> at which to begin writing.</param>
/// <exception cref="ArgumentException">Invalid offset or <paramref name="source"/>
/// is too large to be written to the IStorage. </exception>
Result Write(long offset, ReadOnlySpan<byte> source);
/// <param name="source">The buffer containing the bytes to be written.</param>
/// <returns>The <see cref="Result"/> of the operation.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Result Write(long offset, ReadOnlySpan<byte> source)
{
if (IsDisposed)
return ResultFs.PreconditionViolation.Log();
return DoWrite(offset, source);
}
/// <summary>
/// Causes any buffered data to be written to the underlying device.
/// </summary>
Result Flush();
/// <returns>The <see cref="Result"/> of the operation.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Result Flush()
{
if (IsDisposed)
return ResultFs.PreconditionViolation.Log();
return DoFlush();
}
/// <summary>
/// Sets the size of the current IStorage.
/// Sets the size of the current <see cref="IStorage"/>.
/// </summary>
/// <param name="size">The desired size of the current IStorage in bytes.</param>
Result SetSize(long size);
/// <param name="size">The desired size of the <see cref="IStorage"/> in bytes.</param>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Result SetSize(long size)
{
if (IsDisposed)
return ResultFs.PreconditionViolation.Log();
return DoSetSize(size);
}
/// <summary>
/// The size of the<see cref="IStorage"/>. -1 will be returned if
/// the <see cref="IStorage"/> cannot be represented as a sequence of contiguous bytes.
/// Gets the number of bytes in the <see cref="IStorage"/>.
/// </summary>
/// <returns>The size of the <see cref="IStorage"/> in bytes.</returns>
Result GetSize(out long size);
/// <param name="size">If the operation returns successfully, the length of the file in bytes.</param>
/// <returns>The <see cref="Result"/> of the operation.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Result GetSize(out long size)
{
if (IsDisposed)
{
size = default;
return ResultFs.PreconditionViolation.Log();
}
return DoGetSize(out size);
}
/// <summary>
/// Performs various operations on the file. Used to extend the functionality of the <see cref="IStorage"/> interface.
@ -51,8 +101,56 @@ namespace LibHac.Fs
/// <param name="offset">The offset of the range to operate on.</param>
/// <param name="size">The size of the range to operate on.</param>
/// <param name="inBuffer">An input buffer. Size may vary depending on the operation performed.</param>
/// <returns>The <see cref="Result"/> of the requested operation.</returns>
Result OperateRange(Span<byte> outBuffer, OperationId operationId, long offset, long size,
ReadOnlySpan<byte> inBuffer);
/// <returns>The <see cref="Result"/> of the operation.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Result OperateRange(Span<byte> outBuffer, OperationId operationId, long offset, long size,
ReadOnlySpan<byte> inBuffer)
{
if (IsDisposed)
return ResultFs.PreconditionViolation.Log();
return DoOperateRange(outBuffer, operationId, offset, size, inBuffer);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsRangeValid(long offset, long size, long totalSize)
{
return offset >= 0 &&
size >= 0 &&
size <= totalSize &&
offset <= totalSize - size;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsOffsetAndSizeValid(long offset, long size)
{
return offset >= 0 &&
size >= 0 &&
offset <= offset - size;
}
protected abstract Result DoRead(long offset, Span<byte> destination);
protected abstract Result DoWrite(long offset, ReadOnlySpan<byte> source);
protected abstract Result DoFlush();
protected abstract Result DoGetSize(out long size);
protected abstract Result DoSetSize(long size);
protected virtual Result DoOperateRange(Span<byte> outBuffer, OperationId operationId, long offset, long size,
ReadOnlySpan<byte> inBuffer)
{
return ResultFs.NotImplemented.Log();
}
public void Dispose()
{
// Make sure Dispose is only called once
if (Interlocked.CompareExchange(ref _disposedState, 1, 0) == 0)
{
Dispose(true);
GC.SuppressFinalize(this);
}
}
protected virtual void Dispose(bool disposing) { }
}
}

12
src/LibHac/Fs/MemoryStorage.cs
View File

@ -2,7 +2,7 @@
namespace LibHac.Fs
{
public class MemoryStorage : StorageBase
public class MemoryStorage : IStorage
{
private byte[] StorageBuffer { get; }
@ -11,7 +11,7 @@ namespace LibHac.Fs
StorageBuffer = buffer;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
if (destination.Length == 0)
return Result.Success;
@ -24,7 +24,7 @@ namespace LibHac.Fs
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
if (source.Length == 0)
return Result.Success;
@ -37,17 +37,17 @@ namespace LibHac.Fs
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.UnsupportedOperationInMemoryStorageSetSize.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = StorageBuffer.Length;

87
src/LibHac/Fs/StorageBase.cs
View File

@ -1,87 +0,0 @@
using System;
using System.Runtime.CompilerServices;
using System.Threading;
namespace LibHac.Fs
{
public abstract class StorageBase : IStorage
{
// 0 = not disposed; 1 = disposed
private int _disposedState;
private bool IsDisposed => _disposedState != 0;
protected abstract Result ReadImpl(long offset, Span<byte> destination);
protected abstract Result WriteImpl(long offset, ReadOnlySpan<byte> source);
protected abstract Result FlushImpl();
protected abstract Result GetSizeImpl(out long size);
protected abstract Result SetSizeImpl(long size);
protected virtual Result OperateRangeImpl(Span<byte> outBuffer, OperationId operationId, long offset, long size,
ReadOnlySpan<byte> inBuffer)
{
return ResultFs.NotImplemented.Log();
}
public Result Read(long offset, Span<byte> destination)
{
if (IsDisposed) return ResultFs.PreconditionViolation.Log();
return ReadImpl(offset, destination);
}
public Result Write(long offset, ReadOnlySpan<byte> source)
{
if (IsDisposed) return ResultFs.PreconditionViolation.Log();
return WriteImpl(offset, source);
}
public Result Flush()
{
if (IsDisposed) return ResultFs.PreconditionViolation.Log();
return FlushImpl();
}
public Result SetSize(long size)
{
if (IsDisposed) return ResultFs.PreconditionViolation.Log();
return SetSizeImpl(size);
}
public Result GetSize(out long size)
{
size = default;
if (IsDisposed) return ResultFs.PreconditionViolation.Log();
return GetSizeImpl(out size);
}
public Result OperateRange(Span<byte> outBuffer, OperationId operationId, long offset, long size,
ReadOnlySpan<byte> inBuffer)
{
if (IsDisposed) return ResultFs.PreconditionViolation.Log();
return OperateRange(outBuffer, operationId, offset, size, inBuffer);
}
public void Dispose()
{
// Make sure Dispose is only called once
if (Interlocked.CompareExchange(ref _disposedState, 1, 0) == 0)
{
Dispose(true);
GC.SuppressFinalize(this);
}
}
protected virtual void Dispose(bool disposing) { }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsRangeValid(long offset, long size, long totalSize)
{
return offset >= 0 && size >= 0 && size <= totalSize && offset <= totalSize - size;
}
}
}

12
src/LibHac/Fs/SubStorage2.cs
View File

@ -2,7 +2,7 @@
namespace LibHac.Fs
{
public class SubStorage2 : StorageBase
public class SubStorage2 : IStorage
{
private IStorage BaseStorage { get; }
private long Offset { get; }
@ -23,7 +23,7 @@ namespace LibHac.Fs
Size = size;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
if (BaseStorage == null) return ResultFs.SubStorageNotInitialized.Log();
if (destination.Length == 0) return Result.Success;
@ -33,7 +33,7 @@ namespace LibHac.Fs
return BaseStorage.Read(Offset + offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
if (BaseStorage == null) return ResultFs.SubStorageNotInitialized.Log();
if (source.Length == 0) return Result.Success;
@ -43,14 +43,14 @@ namespace LibHac.Fs
return BaseStorage.Write(Offset + offset, source);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
if (BaseStorage == null) return ResultFs.SubStorageNotInitialized.Log();
return BaseStorage.Flush();
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
if (BaseStorage == null) return ResultFs.SubStorageNotInitialized.Log();
if (!IsResizable) return ResultFs.SubStorageNotResizable.Log();
@ -72,7 +72,7 @@ namespace LibHac.Fs
return Result.Success;
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = default;

12
src/LibHac/FsService/Creators/EmulatedGameCardStorageCreator.cs
View File

@ -62,7 +62,7 @@ namespace LibHac.FsService.Creators
throw new NotImplementedException();
}
private class ReadOnlyGameCardStorage : StorageBase
private class ReadOnlyGameCardStorage : IStorage
{
private EmulatedGameCard GameCard { get; }
private GameCardHandle Handle { get; set; }
@ -87,7 +87,7 @@ namespace LibHac.FsService.Creators
imageHash.CopyTo(ImageHash);
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
// In secure mode, if Handle is old and the card's device ID and
// header hash are still the same, Handle is updated to the new handle
@ -95,22 +95,22 @@ namespace LibHac.FsService.Creators
return GameCard.Read(Handle, offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return ResultFs.UnsupportedOperationInRoGameCardStorageWrite.Log();
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.UnsupportedOperationInRoGameCardStorageSetSize.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = 0;

8
src/LibHac/FsSystem/Aes128CtrExStorage.cs
View File

@ -31,7 +31,7 @@ namespace LibHac.FsSystem
SubsectionOffsets = SubsectionEntries.Select(x => x.Offset).ToList();
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
AesSubsectionEntry entry = GetSubsectionEntry(offset);
@ -47,7 +47,7 @@ namespace LibHac.FsSystem
{
UpdateCounterSubsection(entry.Counter);
Result rc = base.ReadImpl(inPos, destination.Slice(outPos, bytesToRead));
Result rc = base.DoRead(inPos, destination.Slice(outPos, bytesToRead));
if (rc.IsFailure()) return rc;
}
@ -64,12 +64,12 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return ResultFs.UnsupportedOperationInAesCtrExStorageWrite.Log();
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return Result.Success;
}

8
src/LibHac/FsSystem/Aes128CtrStorage.cs
View File

@ -59,9 +59,9 @@ namespace LibHac.FsSystem
Counter = _decryptor.Counter;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
Result rc = base.ReadImpl(offset, destination);
Result rc = base.DoRead(offset, destination);
if (rc.IsFailure()) return rc;
lock (_locker)
@ -73,7 +73,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
byte[] encrypted = ArrayPool<byte>.Shared.Rent(source.Length);
try
@ -87,7 +87,7 @@ namespace LibHac.FsSystem
_decryptor.TransformBlock(encryptedSpan);
}
Result rc = base.WriteImpl(offset, encryptedSpan);
Result rc = base.DoWrite(offset, encryptedSpan);
if (rc.IsFailure()) return rc;
}
finally

10
src/LibHac/FsSystem/Aes128XtsStorage.cs
View File

@ -38,14 +38,14 @@ namespace LibHac.FsSystem
_key2 = key2.ToArray();
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
int size = destination.Length;
long sectorIndex = offset / SectorSize;
if (_decryptor == null) _decryptor = new Aes128XtsTransform(_key1, _key2, true);
Result rc = base.ReadImpl(offset, _tempBuffer.AsSpan(0, size));
Result rc = base.DoRead(offset, _tempBuffer.AsSpan(0, size));
if (rc.IsFailure()) return rc;
_decryptor.TransformBlock(_tempBuffer, 0, size, (ulong)sectorIndex);
@ -54,7 +54,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
int size = source.Length;
long sectorIndex = offset / SectorSize;
@ -64,10 +64,10 @@ namespace LibHac.FsSystem
source.CopyTo(_tempBuffer);
_encryptor.TransformBlock(_tempBuffer, 0, size, (ulong)sectorIndex);
return base.WriteImpl(offset, _tempBuffer.AsSpan(0, size));
return base.DoWrite(offset, _tempBuffer.AsSpan(0, size));
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseStorage.Flush();
}

12
src/LibHac/FsSystem/CachedStorage.cs
View File

@ -4,7 +4,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class CachedStorage : StorageBase
public class CachedStorage : IStorage
{
private IStorage BaseStorage { get; }
private int BlockSize { get; }
@ -33,7 +33,7 @@ namespace LibHac.FsSystem
public CachedStorage(SectorStorage baseStorage, int cacheSize, bool leaveOpen)
: this(baseStorage, baseStorage.SectorSize, cacheSize, leaveOpen) { }
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
long remaining = destination.Length;
long inOffset = offset;
@ -63,7 +63,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
long remaining = source.Length;
long inOffset = offset;
@ -95,7 +95,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
lock (Blocks)
{
@ -108,13 +108,13 @@ namespace LibHac.FsSystem
return BaseStorage.Flush();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
Result rc = BaseStorage.SetSize(size);
if (rc.IsFailure()) return rc;

12
src/LibHac/FsSystem/ConcatenationStorage.cs
View File

@ -4,7 +4,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class ConcatenationStorage : StorageBase
public class ConcatenationStorage : IStorage
{
private ConcatSource[] Sources { get; }
private long Length { get; }
@ -28,7 +28,7 @@ namespace LibHac.FsSystem
Length = length;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
long inPos = offset;
int outPos = 0;
@ -59,7 +59,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
long inPos = offset;
int outPos = 0;
@ -90,7 +90,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
foreach (ConcatSource source in Sources)
{
@ -101,12 +101,12 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.NotImplemented.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;

12
src/LibHac/FsSystem/FileStorage.cs
View File

@ -4,7 +4,7 @@ using LibHac.Fs.Fsa;
namespace LibHac.FsSystem
{
public class FileStorage : StorageBase
public class FileStorage : IStorage
{
protected IFile BaseFile { get; }
@ -13,27 +13,27 @@ namespace LibHac.FsSystem
BaseFile = baseFile;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
return BaseFile.Read(out long _, offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return BaseFile.Write(offset, source);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseFile.Flush();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
return BaseFile.GetSize(out size);
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return BaseFile.SetSize(size);
}

12
src/LibHac/FsSystem/HierarchicalIntegrityVerificationStorage.cs
View File

@ -7,7 +7,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class HierarchicalIntegrityVerificationStorage : StorageBase
public class HierarchicalIntegrityVerificationStorage : IStorage
{
public IStorage[] Levels { get; }
public IStorage DataLevel { get; }
@ -96,27 +96,27 @@ namespace LibHac.FsSystem
return initInfo;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
return DataLevel.Read(offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return DataLevel.Write(offset, source);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return DataLevel.Flush();
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.UnsupportedOperationInHierarchicalIvfcStorageSetSize.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;

12
src/LibHac/FsSystem/IndirectStorage.cs
View File

@ -5,7 +5,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class IndirectStorage : StorageBase
public class IndirectStorage : IStorage
{
private List<RelocationEntry> RelocationEntries { get; }
private List<long> RelocationOffsets { get; }
@ -29,7 +29,7 @@ namespace LibHac.FsSystem
Length = BucketTree.BucketOffsets.OffsetEnd;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
RelocationEntry entry = GetRelocationEntry(offset);
@ -64,23 +64,23 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return ResultFs.UnsupportedOperationInIndirectStorageSetSize.Log();
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return Result.Success;
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.UnsupportedOperationInIndirectStorageSetSize.Log();
}

8
src/LibHac/FsSystem/IntegrityVerificationStorage.cs
View File

@ -117,7 +117,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
return ReadImpl(offset, destination, IntegrityCheckLevel);
}
@ -128,7 +128,7 @@ namespace LibHac.FsSystem
return ReadImpl(offset, destination, integrityCheckLevel);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
long blockIndex = offset / SectorSize;
long hashPos = blockIndex * DigestSize;
@ -188,12 +188,12 @@ namespace LibHac.FsSystem
}
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
Result rc = HashStorage.Flush();
if (rc.IsFailure()) return rc;
return base.FlushImpl();
return base.DoFlush();
}
public void FsTrim()

12
src/LibHac/FsSystem/LocalStorage.cs
View File

@ -4,7 +4,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class LocalStorage : StorageBase
public class LocalStorage : IStorage
{
private string Path { get; }
private FileStream Stream { get; }
@ -19,27 +19,27 @@ namespace LibHac.FsSystem
Storage = new StreamStorage(Stream, false);
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
return Storage.Read(offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return Storage.Write(offset, source);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return Storage.Flush();
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.NotImplemented.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
return Storage.GetSize(out size);
}

12
src/LibHac/FsSystem/NullStorage.cs
View File

@ -6,7 +6,7 @@ namespace LibHac.FsSystem
/// <summary>
/// An <see cref="IStorage"/> that returns all zeros when read, and does nothing on write.
/// </summary>
public class NullStorage : StorageBase
public class NullStorage : IStorage
{
private long Length { get; }
@ -14,28 +14,28 @@ namespace LibHac.FsSystem
public NullStorage(long length) => Length = length;
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
destination.Clear();
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.NotImplemented.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;

12
src/LibHac/FsSystem/Save/AllocationTableStorage.cs
View File

@ -4,7 +4,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem.Save
{
public class AllocationTableStorage : StorageBase
public class AllocationTableStorage : IStorage
{
private IStorage BaseStorage { get; }
private int BlockSize { get; }
@ -23,7 +23,7 @@ namespace LibHac.FsSystem.Save
_length = initialBlock == -1 ? 0 : table.GetListLength(initialBlock) * blockSize;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
var iterator = new AllocationTableIterator(Fat, InitialBlock);
@ -53,7 +53,7 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
var iterator = new AllocationTableIterator(Fat, InitialBlock);
@ -83,18 +83,18 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseStorage.Flush();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = _length;
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
int oldBlockCount = (int)Util.DivideByRoundUp(_length, BlockSize);
int newBlockCount = (int)Util.DivideByRoundUp(size, BlockSize);

12
src/LibHac/FsSystem/Save/DuplexStorage.cs
View File

@ -3,7 +3,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem.Save
{
public class DuplexStorage : StorageBase
public class DuplexStorage : IStorage
{
private int BlockSize { get; }
private IStorage BitmapStorage { get; }
@ -27,7 +27,7 @@ namespace LibHac.FsSystem.Save
Length = dataSize;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
long inPos = offset;
int outPos = 0;
@ -56,7 +56,7 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
long inPos = offset;
int outPos = 0;
@ -85,7 +85,7 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
Result rc = BitmapStorage.Flush();
if (rc.IsFailure()) return rc;
@ -99,12 +99,12 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.NotImplemented.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;

12
src/LibHac/FsSystem/Save/HierarchicalDuplexStorage.cs
View File

@ -3,7 +3,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem.Save
{
public class HierarchicalDuplexStorage : StorageBase
public class HierarchicalDuplexStorage : IStorage
{
private DuplexStorage[] Layers { get; }
private DuplexStorage DataLayer { get; }
@ -34,27 +34,27 @@ namespace LibHac.FsSystem.Save
Length = dataSize;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
return DataLayer.Read(offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
return DataLayer.Write(offset, source);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return DataLayer.Flush();
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.NotImplemented.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;

12
src/LibHac/FsSystem/Save/JournalStorage.cs
View File

@ -5,7 +5,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem.Save
{
public class JournalStorage : StorageBase
public class JournalStorage : IStorage
{
private IStorage BaseStorage { get; }
private IStorage HeaderStorage { get; }
@ -33,7 +33,7 @@ namespace LibHac.FsSystem.Save
LeaveOpen = leaveOpen;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
long inPos = offset;
int outPos = 0;
@ -62,7 +62,7 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
long inPos = offset;
int outPos = 0;
@ -91,17 +91,17 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseStorage.Flush();
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.NotImplemented.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;

12
src/LibHac/FsSystem/Save/RemapStorage.cs
View File

@ -6,7 +6,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem.Save
{
public class RemapStorage : StorageBase
public class RemapStorage : IStorage
{
private const int MapEntryLength = 0x20;
@ -48,7 +48,7 @@ namespace LibHac.FsSystem.Save
Segments = InitSegments(Header, MapEntries);
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
if (destination.Length == 0) return Result.Success;
@ -78,7 +78,7 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
if (source.Length == 0) return Result.Success;
@ -110,17 +110,17 @@ namespace LibHac.FsSystem.Save
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseStorage.Flush();
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.UnsupportedOperationInHierarchicalIvfcStorageSetSize.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
// todo: Different result code
size = -1;

12
src/LibHac/FsSystem/SectorStorage.cs
View File

@ -3,7 +3,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class SectorStorage : StorageBase
public class SectorStorage : IStorage
{
protected IStorage BaseStorage { get; }
@ -26,30 +26,30 @@ namespace LibHac.FsSystem
LeaveOpen = leaveOpen;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
ValidateSize(destination.Length, offset);
return BaseStorage.Read(offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
ValidateSize(source.Length, offset);
return BaseStorage.Write(offset, source);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseStorage.Flush();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
Result rc = BaseStorage.SetSize(size);
if (rc.IsFailure()) return rc;

12
src/LibHac/FsSystem/StreamStorage.cs
View File

@ -4,7 +4,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class StreamStorage : StorageBase
public class StreamStorage : IStorage
{
// todo: handle Stream exceptions
@ -20,7 +20,7 @@ namespace LibHac.FsSystem
LeaveOpen = leaveOpen;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
lock (Locker)
{
@ -35,7 +35,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
lock (Locker)
{
@ -50,7 +50,7 @@ namespace LibHac.FsSystem
return Result.Success;
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
lock (Locker)
{
@ -60,12 +60,12 @@ namespace LibHac.FsSystem
}
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
return ResultFs.NotImplemented.Log();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;

12
src/LibHac/FsSystem/SubStorage.cs
View File

@ -4,7 +4,7 @@ using LibHac.Fs;
namespace LibHac.FsSystem
{
public class SubStorage : StorageBase
public class SubStorage : IStorage
{
private IStorage BaseStorage { get; }
private long Offset { get; }
@ -38,30 +38,30 @@ namespace LibHac.FsSystem
Access = access;
}
protected override Result ReadImpl(long offset, Span<byte> destination)
protected override Result DoRead(long offset, Span<byte> destination)
{
if ((Access & FileAccess.Read) == 0) throw new InvalidOperationException("Storage is not readable");
return BaseStorage.Read(offset + Offset, destination);
}
protected override Result WriteImpl(long offset, ReadOnlySpan<byte> source)
protected override Result DoWrite(long offset, ReadOnlySpan<byte> source)
{
if ((Access & FileAccess.Write) == 0) throw new InvalidOperationException("Storage is not writable");
return BaseStorage.Write(offset + Offset, source);
}
protected override Result FlushImpl()
protected override Result DoFlush()
{
return BaseStorage.Flush();
}
protected override Result GetSizeImpl(out long size)
protected override Result DoGetSize(out long size)
{
size = Length;
return Result.Success;
}
protected override Result SetSizeImpl(long size)
protected override Result DoSetSize(long size)
{
if (BaseStorage == null) return ResultFs.SubStorageNotInitialized.Log();