.NET 6+ FileStream의 구조 변화

아래의 글에,

C# - byte * (바이트 포인터)를 FileStream으로 쓰는 방법
; https://www.sysnet.pe.kr/2/0/12913

다음과 같은 내용의 덧글이 있습니다.



시간이 좀 지났으니, 현재의 구현이 어떻게 되어 있는지 살펴보겠습니다. ^^

---

우선, FileStream의 Span을 받는 Write 메서드를 보면,

public override void Write(ReadOnlySpan<byte> buffer) => _strategy.Write(buffer);

호출을 _strategy로 전달하고 있습니다. 이 멤버는 FileStream 생성자에서 결정되는데요,

public FileStream(SafeFileHandle handle, FileAccess access, int bufferSize)
{
    ValidateHandle(handle, access, bufferSize);

    _strategy = FileStreamHelpers.ChooseStrategy(this, handle, access, bufferSize, handle.IsAsync);
}

FileStreamHelpers.ChooseStrategy는 다시,

namespace System.IO.Strategies
{
    internal static partial class FileStreamHelpers
    {
        // ...[생략]...

        internal static FileStreamStrategy ChooseStrategy(FileStream fileStream, SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync)
        {
            FileStreamStrategy strategy =
                EnableBufferingIfNeeded(ChooseStrategyCore(handle, access, isAsync), bufferSize);

            return WrapIfDerivedType(fileStream, strategy);
        }

        // ...[생략]...
    }
}

ChooseStrategyCore로 역할을 맡기고 있습니다. 여기서 재미있는 것은 FileStreamHelpers 자체가 partial class라는 점입니다. 이유는 짐작 가시죠? ^^

윈도우뿐만 아니라 리눅스 등도 지원해야 하기 때문에 FileStreamHelpers는 partial로 플랫폼에 따라 다른 파일을 포함해 빌드하게 됩니다. 일례로 윈도우의 경우 FileStreamHelpers.Windows.cs 파일을 포함하고, 그 파일의 ChooseStrategyCore를 보면,

private static FileStreamStrategy ChooseStrategyCore(string path, FileMode mode, FileAccess access, FileShare share, FileOptions options, long preallocationSize, UnixFileMode? unixCreateMode) =>
    (options & FileOptions.Asynchronous) != 0 ?
        new AsyncWindowsFileStreamStrategy(path, mode, access, share, options, preallocationSize, unixCreateMode) :
        new SyncWindowsFileStreamStrategy(path, mode, access, share, options, preallocationSize, unixCreateMode);

동기/비동기에 따라 다른 타입을 생성해 반환합니다. 2가지 중에 여기서는 SyncWindowsFileStreamStrategy.cs로 들어가 보겠습니다. ^^

using Microsoft.Win32.SafeHandles;

namespace System.IO.Strategies
{
    internal sealed class SyncWindowsFileStreamStrategy : OSFileStreamStrategy
    {
        internal SyncWindowsFileStreamStrategy(SafeFileHandle handle, FileAccess access) : base(handle, access)
        {
        }

        internal SyncWindowsFileStreamStrategy(string path, FileMode mode, FileAccess access, FileShare share, FileOptions options, long preallocationSize, UnixFileMode? unixCreateMode)
            : base(path, mode, access, share, options, preallocationSize, unixCreateMode)
        {
        }

        internal override bool IsAsync => false;
    }
}

partial이 아니므로 이번에는 대부분의 구현이 부모 클래스에 있을 텐데요, 정의를 가보면 Write 메서드의 본체를 볼 수 있습니다.

// OSFileStreamStrategy.cs

public sealed override void Write(ReadOnlySpan<byte> buffer)
{
    if (_fileHandle.IsClosed)
    {
        ThrowHelper.ThrowObjectDisposedException_FileClosed();
    }
    else if ((_access & FileAccess.Write) == 0)
    {
        ThrowHelper.ThrowNotSupportedException_UnwritableStream();
    }

    RandomAccess.WriteAtOffset(_fileHandle, buffer, _filePosition);
    _filePosition += buffer.Length;
}

아쉽게도 여기가 끝이 아니군요. ^^ RandomAccess.WriteAtOffset으로 인자를 그대로 전달하는데, 이것 역시 partial 클래스로,

// RandomAccess.cs

namespace System.IO
{
    public static partial class RandomAccess
    {
         // ...[생략]...
    }
}

빌드 시 대상 플랫폼에 따라 다른 소스코드 파일과 엮이게 됩니다. 윈도우의 경우는 RandomAccess.Windows.cs 파일이 포함되는데,

// RandomAccess.Windows.cs

namespace System.IO
{
    public static partial class RandomAccess
    {
        // ...[생략]...

        internal static unsafe void WriteAtOffset(SafeFileHandle handle, ReadOnlySpan<byte> buffer, long fileOffset)
        {
            // ...[생략]...

            NativeOverlapped overlapped = GetNativeOverlappedForSyncHandle(handle, fileOffset);
            fixed (byte* pinned = &MemoryMarshal.GetReference(buffer))
            {
                if (Interop.Kernel32.WriteFile(handle, pinned, buffer.Length, out int numBytesWritten, &overlapped) != 0)
                {
                    Debug.Assert(numBytesWritten == buffer.Length);
                    return;
                }

                int errorCode = FileStreamHelpers.GetLastWin32ErrorAndDisposeHandleIfInvalid(handle);
                throw Win32Marshal.GetExceptionForWin32Error(errorCode, handle.Path);
            }
        }
    }
}

보는 바와 같이 Kernel32.WriteFile Win32 API 호출을 바로 하고 있습니다. 즉, Span 인자로 넘긴 데이터의 복사는 발생하지 않으니 안심하고 사용하셔도 되겠습니다. ^^

---

시작은 Write 메서드의 버퍼 복사를 살펴보려는 것이었는데, 뜻하지 않게 다중 플랫폼 지원을 추가하느라 바뀐 FileStream의 구현을 들여다보게 되었습니다. 아울러, 아래의 문서를 보면,

File IO improvements in .NET 6
; https://devblogs.microsoft.com/dotnet/file-io-improvements-in-dotnet-6/

.NET 5까지는 Span Write 메서드에 대해 Net5CompatFileStreamStrategy 소스코드에서 확인할 수 있는 것처럼, 버퍼 복사가 이뤄집니다.

// Net5CompatFileStreamStrategy.Windows.cs

private void WriteSpan(ReadOnlySpan<byte> source)
{
    // ...[생략]...

    if (_writePos > 0)
    {
        int numBytes = _bufferLength - _writePos;   // space left in buffer
        if (numBytes > 0)
        {
            if (numBytes >= source.Length)
            {
                source.CopyTo(GetBuffer().AsSpan(_writePos));
                _writePos += source.Length;
                return;
            }
            else
            {
                source.Slice(0, numBytes).CopyTo(GetBuffer().AsSpan(_writePos));
                _writePos += numBytes;
                source = source.Slice(numBytes);
            }
        }

        // ...[생략]...
    }

    // ...[생략]...

    // Copy remaining bytes into buffer, to write at a later date.
    source.CopyTo(GetBuffer().AsSpan(_writePos));
    _writePos = source.Length;
    return;
}

그러니까, .NET 6+로 업데이트하는 것만으로도 "File IO improvements in .NET 6" 문서의 내용대로 성능 향상을 볼 수 있습니다.

---

[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[최초 등록일: 4/5/2023]
[최종 수정일: 4/5/2023]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com