Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 1개 있습니다.)

C# - FILE_FLAG_OVERLAPPED가 적용된 파일의 읽기/쓰기 시 Position 관리

아래의 글을,

C# - CLR ThreadPool의 I/O 스레드에 작업을 맡기는 방법
; https://www.sysnet.pe.kr/2/0/13059

이렇게 실습해 보면,

using Console1;
using Microsoft.Win32.SafeHandles;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.InteropServices;
using System.Runtime.Versioning;
using System.Text;

[assembly: SupportedOSPlatform("windows")]

class Program
{
    static void Main(string[] args)
    {
        byte[] buffer = Encoding.UTF8.GetBytes("tt");
        byte[] buffer2 = Encoding.UTF8.GetBytes("ee");

        File.Delete(@"C:\temp\test.txt");

        using (SafeFileHandle pHandle = NativeMethods.CreateFile(@"c:\temp\test.txt",
                (uint)FileAccess.ReadWrite,
                0,
                IntPtr.Zero,
                (uint)2,
                NativeMethods.FILE_FLAG_OVERLAPPED,
                IntPtr.Zero))
        {
            WriteAsync(pHandle, buffer);
            Thread.Sleep(1000);
            WriteAsync(pHandle, buffer2);
        }

        Console.WriteLine("Press Enter to exit ...");
        Console.ReadLine();
    }

    private static void WriteAsync(SafeFileHandle pHandle, byte[] buf)
    {
        uint written;
        NativeOverlapped o = new NativeOverlapped();

        EventWaitHandle writeEvent = new EventWaitHandle(false, EventResetMode.AutoReset);
        o.EventHandle = writeEvent.SafeWaitHandle.DangerousGetHandle();

        if (NativeMethods.WriteFile(pHandle, buf, buf.Length, out written, ref o) == false)
        {
            int lastError = Marshal.GetLastWin32Error();
            if (lastError == 997) //  ERROR_IO_PENDING == 997
            {
                OverlappedParameter op = new OverlappedParameter()
                {
                    Event = writeEvent,
                };

                op.WaitHandle = ThreadPool.RegisterWaitForSingleObject(writeEvent, WriteCompleted, op, -1, false);
                op.TryUnregister();
            }
            else
            {
                // Write File Error
                Console.WriteLine("Write File Error");
                writeEvent.Close();
            }
        }
    }

    public static void WriteCompleted(object? objState, bool timedOut)
    {
        Console.WriteLine($"{DateTime.Now} async WriteCompleted");

        OverlappedParameter? op = objState as OverlappedParameter;
        if (op == null)
        {
            return;
        }

        op.Done();
    }
}

public class OverlappedParameter
{
    // ...[생략]...
}

2번의 WriteAsync 호출에서 전달한 2바이트 내용이,

WriteAsync(pHandle, buf); // buf == 'tt'
Thread.Sleep(1000);
WriteAsync(pHandle, buf2); // buf2 == 'ee'

"FileStream.Position == 0"인 위치에 써지기 때문에 출력 파일의 결과는 "ee"만 담고 있게 됩니다. 실제로 FILE_FLAG_OVERLAPPED가 적용된 파일은 Read/Write 동작을 한 후 파일 포인터를 전혀 변경하지 않습니다. 가령, 다음과 같이 SetFilePointerEx Win32 API를 호출해 현재의 파일 포인터 위치를 구해봐도,

WriteAsync(pHandle, buf);
Thread.Sleep(1000);
Console.WriteLine(GetCurrentPosition(pHandle)); // 출력 결과: 0

WriteAsync(pHandle, buf2);

private static long GetCurrentPosition(SafeFileHandle handle)
{
    if (NativeMethods.SetFilePointerEx(handle, 0, out long result, NativeMethods.FILE_CURRENT) == true)
    {
        return result;
    }

    return 0;
}

0이 나옵니다. 좀 이상한가요? ^^




사실 이것은 맞는 동작이긴 합니다. 왜냐하면 비동기 읽기/쓰기를 위해 ReadFile/WriteFile에 전달하는 NativeOverlapped 구조체에는 이미 OffsetLow, OffsetHigh 필드를 통해 (FileStream.Position에 해당하는) 위치를 지정하기 때문입니다.

그래서, 정확한 결과를 보려면 위와 같은 소스 코드에서 WriteAsync 메서드에 데이터가 쓰일 위치를 함께 전달해야 합니다.

using (SafeFileHandle pHandle = NativeMethods.CreateFile(@"c:\temp\test.txt",
        (uint)FileAccess.ReadWrite, 0, IntPtr.Zero, (uint)2, NativeMethods.FILE_FLAG_OVERLAPPED, IntPtr.Zero))
{
    WriteAsync(pHandle, 0, buf);
    Thread.Sleep(1000);
    WriteAsync(pHandle, 2, buf2);
}

private static void WriteAsync(SafeFileHandle pHandle, long pos, byte[] buf)
{
    //...[생략]...
    NativeOverlapped o = new NativeOverlapped();

    o.OffsetLow = unchecked((int)pos);
    o.OffsetHigh = (int)(pos >> 32);

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

// test.txt 파일 내용: "ttee"

재미있는 것은 우리가 사용하는 FileStream의 WriteAsync는 Read/Write는 별도의 File Position을 전달하지 않습니다.

using System;
using System.Text;

internal class Program
{
    static async Task Main(string[] args)
    {
        string filePath = @"C:\temp\test.txt";

        File.Delete(filePath);
        using (FileStream fs = File.OpenWrite(filePath))
        {

            byte[] buffer = Encoding.UTF8.GetBytes("tt");
            byte[] buffer2 = Encoding.UTF8.GetBytes("ee");

            await fs.WriteAsync(buffer, 0, buffer.Length);
            await fs.WriteAsync(buffer2, 0, buffer2.Length);

            // test.txt 파일 내용
            // ttee
        }
    }
}

왜냐하면 내부적으로 "_pos"라는 필드를 FileStream에서 관리를 하기 때문입니다. 여기서 더욱 재미있는 것은, FileStream은 최대한 _pos와 FILE 자원의 포인터 위치를 맞추려고 노력한다는 점입니다. 그래서 단순히 WriteAsync와 같은 동작을 할 때 _pos 변수만 업데이트하는 것이 아니라, SetFilePointer를 이용해 파일 포인터 위치까지 바꿔줍니다.

// 참고: https://github.com/microsoft/referencesource/blob/master/mscorlib/system/io/filestream.cs#L2010

intOverlapped->OffsetLow = unchecked((int)_pos);
intOverlapped->OffsetHigh = (int)(_pos>>32);

SeekCore(numBytes, SeekOrigin.Current);

[System.Security.SecuritySafeCritical]
private long SeekCore(long offset, SeekOrigin origin) {
    int hr = 0;
    long ret = 0;
            
    ret = Win32Native.SetFilePointer(_handle, offset, origin, out hr);
    if (ret == -1) {
        if (hr == Win32Native.ERROR_INVALID_HANDLE)
            _handle.Dispose();
        __Error.WinIOError(hr, String.Empty);
    }
            
    _pos = ret;
    return ret;}
}

그런데, 위에서 보면 약간의 허점이 있긴 합니다. 즉, 어쨌든 비동기 I/O의 파일 위치는 _pos 변수를 기준으로 하기 때문에 파일 포인터의 위치와는 무관하다는 점입니다. 그래서, 만약 해당 파일에 대해 직접 SetFilePointerEx 함수를 이용해 파일 포인터를 변경하는 것은,

static async Task Main(string[] args)
{
    string filePath = @"C:\temp\test.txt";

    File.Delete(filePath);
    using (FileStream fs = File.OpenWrite(filePath))
    {
        byte[] buffer = Encoding.UTF8.GetBytes("tt");
        byte[] buffer2 = Encoding.UTF8.GetBytes("ee");

        await fs.WriteAsync(buffer, 0, buffer.Length);

        NativeMethods.SetFilePointerEx(fs.SafeFileHandle, 0, out _, NativeMethods.FILE_BEGIN);

        await fs.WriteAsync(buffer2, 0, buffer2.Length);
    }
}

/* test 파일 출력 결과
ttee
*/

WriteAsync에 아무런 효력도 없습니다. 반면, FileStream이 제공하는 Position 필드를 이용해 위치를 바꾸는 것은,

await fs.WriteAsync(buffer, 0, buffer.Length);

fs.Position = 0; // 내부적으로 _pos 필드를 업데이트하기 때문에,

await fs.WriteAsync(buffer2, 0, buffer2.Length);

/* test 파일 출력 결과
ee
*/

효력을 발휘합니다. 은근슬쩍 복잡한 상황들이 전개됩니다. ^^




자, 그럼 최종적으로 우리가 구현하는 비동기 파일 연산도 별도의 클래스를 만들어 대충 이런 식으로 구색을 낼 수 있습니다.

public class MyAsyncFileStream : IDisposable
{
    long _pos;
    SafeFileHandle? _pHandle;

    public MyAsyncFileStream(string filePath)
    {
        _pHandle = NativeMethods.CreateFile(@"c:\temp\test.txt",
            (uint)FileAccess.ReadWrite,
            0,
            IntPtr.Zero,
            (uint)2,
            NativeMethods.FILE_FLAG_OVERLAPPED,
            IntPtr.Zero);
    }

    public long Position
    {
        get { return _pos; }
        set
        {
            _pos = value;
            SeekCore(_pos, SeekOrigin.Begin);
        }
    }

    void SeekCore(long offset, SeekOrigin origin)
    {
        if (NativeMethods.SetFilePointerEx(_pHandle!, offset, out long moved, (uint)origin) == true)
        {
            _pos = moved;
        }
    }

    public void WriteAsync(byte[] buf)
    {
        uint written;
        NativeOverlapped o = new NativeOverlapped();
        o.OffsetLow = unchecked((int)_pos);
        o.OffsetHigh = (int)(_pos >> 32);

        SeekCore(buf.Length, SeekOrigin.Current);

        EventWaitHandle writeEvent = new EventWaitHandle(false, EventResetMode.AutoReset);
        o.EventHandle = writeEvent.SafeWaitHandle.DangerousGetHandle();

        if (NativeMethods.WriteFile(_pHandle!, buf, buf.Length, out written, ref o) == false)
        {
            int lastError = Marshal.GetLastWin32Error();
            if (lastError == 997) //  ERROR_IO_PENDING == 997
            {
                OverlappedParameter op = new OverlappedParameter()
                {
                    Event = writeEvent,
                };

                op.WaitHandle = ThreadPool.RegisterWaitForSingleObject(writeEvent, WriteCompleted, op, -1, false);
                op.TryUnregister();
            }
            else
            {
                // Write File Error
                Console.WriteLine("Write File Error");
                writeEvent.Close();
            }
        }
    }

    public static void WriteCompleted(object? objState, bool timedOut)
    {
        Console.WriteLine($"{DateTime.Now} async WriteCompleted");

        OverlappedParameter? op = objState as OverlappedParameter;
        if (op == null)
        {
            return;
        }

        op.Done();
    }

    public void Dispose()
    {
        if (_pHandle != null)
        {
            _pHandle.Dispose();
            _pHandle = null;
        }
    }
}

public class OverlappedParameter
{
    // ...[생략]...
}

그리고 사용을 이렇게 하면,

static void Main(string[] args)
{
    byte[] buffer = Encoding.UTF8.GetBytes("tt");
    byte[] buffer2 = Encoding.UTF8.GetBytes("ee");

    File.Delete(@"C:\temp\test.txt");

    using (MyAsyncFileStream fs = new MyAsyncFileStream("C:\temp\test.txt"))
    {
        fs.WriteAsync(buffer);
        Console.WriteLine(fs.Position); // 출력 결과: 2
        fs.WriteAsync(buffer2);
    }

    Console.WriteLine("Press Enter to exit ...");
    Console.ReadLine();
}

/* test.txt 파일 출력 결과
ttee
*/

FileStream처럼 별도의 파일 위치를 관리할 필요 없이 순차적으로 read/write 연산을 할 수 있습니다.

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




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

[연관 글]






[최초 등록일: ]
[최종 수정일: 12/1/2022]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




1  2  3  4  5  [6]  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13112정성태7/30/20221738.NET Framework: 2037. C# 11 - 목록 패턴(List patterns) [1]파일 다운로드1
13111정성태7/29/20221636.NET Framework: 2036. C# 11 - IntPtr/UIntPtr과 nint/nuint의 통합파일 다운로드1
13110정성태7/27/20221753.NET Framework: 2035. C# 11 - 새로운 연산자 ">>>" (Unsigned Right Shift)파일 다운로드1
13109정성태7/27/20221468VS.NET IDE: 177. 비주얼 스튜디오 2022를 이용한 (소스 코드가 없는) 닷넷 모듈 디버깅 - "외부 원본(External Sources)"
13108정성태7/26/20221232Linux: 53. container에 실행 중인 Golang 프로세스를 디버깅하는 방법
13107정성태7/25/20221494Linux: 52. Debian/Ubuntu 계열의 docker container에서 자주 설치하게 되는 명령어
13106정성태7/24/20221109오류 유형: 819. 닷넷 6 프로젝트의 "Conditional compilation symbols" 기본값 오류
13105정성태7/23/20221462.NET Framework: 2034. .NET Core/5+ 환경에서 (프로젝트가 아닌) C# 코드 파일을 입력으로 컴파일하는 방법 - 두 번째 이야기 [1]
13104정성태7/23/20221736Linux: 51. WSL - init에서 systemd로 전환하는 방법
13103정성태7/22/20221416오류 유형: 818. WSL - systemd-genie와 관련한 2가지(systemd-remount-fs.service, multipathd.socket) 에러
13102정성태7/19/20221168.NET Framework: 2033. .NET Core/5+에서는 구할 수 없는 HttpRuntime.AppDomainAppId
13101정성태7/15/20223113도서: 시작하세요! C# 10 프로그래밍
13100정성태7/15/20221583.NET Framework: 2032. C# 11 - shift 연산자 재정의에 대한 제약 완화 (Relaxing Shift Operator)
13099정성태7/14/20221847.NET Framework: 2031. C# 11 - 사용자 정의 checked 연산자파일 다운로드1
13098정성태7/13/20221194개발 환경 구성: 647. Azure - scale-out 상태의 App Service에서 특정 인스턴스에 요청을 보내는 방법 [1]
13097정성태7/12/2022853오류 유형: 817. Golang - binary.Read: invalid type int32
13096정성태7/8/20221683.NET Framework: 2030. C# 11 - UTF-8 문자열 리터럴
13095정성태7/7/20221220Windows: 208. AD 도메인에 참여하지 않은 컴퓨터에서 Kerberos 인증을 사용하는 방법
13094정성태7/6/20221090오류 유형: 816. Golang - "short write" 오류 원인
13093정성태7/5/20221384.NET Framework: 2029. C# - HttpWebRequest로 localhost 접속 시 2초 이상 지연
13092정성태7/3/20221494.NET Framework: 2028. C# - HttpWebRequest의 POST 동작 방식파일 다운로드1
13091정성태7/3/20221177.NET Framework: 2027. C# - IPv4, IPv6를 모두 지원하는 서버 소켓 생성 방법
13090정성태6/29/20221014오류 유형: 815. PyPI에 업로드한 패키지가 반영이 안 되는 경우
13089정성태6/28/20221186개발 환경 구성: 646. HOSTS 파일 변경 시 Edge 브라우저에 반영하는 방법
13088정성태6/27/2022827개발 환경 구성: 645. "Developer Command Prompt for VS 2022" 명령행 환경의 폰트를 바꾸는 방법
13087정성태6/23/20221883스크립트: 41. 파이썬 - FastAPI / uvicorn 호스팅 환경에서 asyncio 사용하는 방법 [1]
1  2  3  4  5  [6]  7  8  9  10  11  12  13  14  15  ...