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 연산을 할 수 있습니다.

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




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

[연관 글]






[최초 등록일: ]
[최종 수정일: 2/16/2023]

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

비밀번호

댓글 작성자
 




... 181  182  183  184  185  186  187  [188]  189  190  191  192  193  194  195  ...
NoWriterDateCnt.TitleFile(s)
254정성태6/1/200617597개발 환경 구성: 2. VPC에 Vista 설치하는 방법 [2]
255정성태6/1/200617351    답변글 개발 환경 구성: 2.1. msconfig 설정과 Windows Activation
259정성태6/1/200616437    답변글 개발 환경 구성: 2.2. Vista VPC에 터미널 서비스 - 원격 접속
253정성태6/1/200614718기타: 14. .NET 2.0 이 지원되는 NDoc 2.0 을 배포합니다.
251정성태6/1/200617766오류 유형: 4. [OS 지원 API] SHParseDisplayName과 Windows 2000
252정성태6/1/200617543    답변글 오류 유형: 4.1. NET BCL 에서 제공되는 FolderBrowserDialog [2]
249정성태6/1/200617015.NET Framework: 71. VB.NET 이외의 언어에서 My 네임스페이스 사용
250정성태6/1/200619674    답변글 .NET Framework: 71.1. VB.NET 이외의 언어에서 My 네임스페이스 사용
248정성태6/1/200617860기타: 13. Code Center Premium에서 Win32 API 소스 찾기
245정성태6/1/200625463오류 유형: 3. [C# / VC++] error C2146: syntax error : missing ';' before identifier 'GetType'
247정성태5/3/200622707    답변글 .NET Framework: 3.1. Interface를 사용하면. [1]
242정성태6/1/200623198오류 유형: 2. [COM+] CreateObject 와 HTTP 500 - Internal server error
243정성태6/1/200620694    답변글 오류 유형: 2.1. [COM+] Resolve Partial Assembly failed for Microsoft.VC80.CRT.mui
244정성태6/1/200621942    답변글 오류 유형: 2.2. [COM+] Server object error 'ASP 0178 : 80070005'
240정성태6/1/200619847스크립트: 9. setTimeout 과 jscript/vbscript 혼용 문제
239정성태6/1/200621117COM 개체 관련: 18. Internet Explorer는 Out-of-process COM 개체입니다.
238정성태6/1/200622961개발 환경 구성: 1. batch 파일에서 실행한 exe에서 batch 실행 문맥의 환경 변수 설정 [3]
236정성태6/1/200643757오류 유형: 1. [.NET COM+] UnauthorizedAccessException: 레지스트리 키 HKEY_CLASSES_ROOT\.... 에 대한 액세스가 거부되었습니다
235정성태6/1/200618404VS.NET IDE: 39. VS.NET 2003/2005에서도 제공되는 VS 6.0 MFC ClassWizard
234정성태4/14/200618138VC++: 24. error C2039: 'pOleStr' : is not a member of '_STRRET'
233정성태4/13/200617502.NET Framework: 70. Response.ContentType 과 Response.AddHeader( "Content-Type", "..." ) 의 차이
232정성태4/13/200617261.NET Framework: 69. Reusing C# Source Code Across Multiple Assemblies
231정성태4/13/200617681Team Foundation Server: 4. How to rename a Team Foundation Server
229정성태10/17/200619211.NET Framework: 68. Feb CTP 에서 동작하는 "Save XPS Document page(s) to .bmp" 예제 소스
230정성태4/13/200619503    답변글 .NET Framework: 68.1. -01 MSDN Magazine XPS Document 소스를 Feb CTP로 수정한 버전파일 다운로드1
228정성태4/13/200615898Team Foundation Server: 3. MSBUILD : warning : Visual Studio Team System for Software Testers or Visual Studio Team System for Software Developers is required to run tests as part of a Team Build.
... 181  182  183  184  185  186  187  [188]  189  190  191  192  193  194  195  ...